Salome HOME
editing description of SALOME_GUI_MODE() macro
authormpa <mpa@opencascade.com>
Mon, 15 Jun 2015 08:13:55 +0000 (11:13 +0300)
committermpa <mpa@opencascade.com>
Mon, 15 Jun 2015 08:13:55 +0000 (11:13 +0300)
adm_local/cmake_files/FindSalomeGUI.cmake

index 59a621a8841590d9023306af0457a322b7310615..0e441f94b4b84832f662e855890e5cd2d2a00846 100644 (file)
@@ -65,12 +65,20 @@ ENDMACRO(SALOME_GUI_WITH_CORBA)
 #   _options [input] List - The list of CMake options given to SALOME GUI
 #
 # Notes:
-# The arguments list can include "OPTIONAL" keywords:
-#  * All arguments preceded by "OPTIONAL" keyword are mandatory for current module.
-#    If GUI module was compiled without this functionality, further installation 
-#    of the current module becomes impossible.
-#  * All arguments following "OPTIONAL" keyword are optional for current module, which
-#    uses this functionality, but can be installed without it.
+# - The arguments list can include "OPTIONAL" keywords:
+#   * All arguments preceded by "OPTIONAL" keyword are mandatory for current module.
+#     If GUI module was compiled without this functionality, further installation 
+#     of the current module becomes impossible.
+#   * All arguments following "OPTIONAL" keyword are optional for current module, which
+#     uses this functionality, but can be installed without it.
+#
+# - At present there are next options in the GUI module:
+#   SALOME_USE_OCCVIEWER, SALOME_USE_VTKVIEWER, SALOME_USE_GLVIEWER, SALOME_USE_PLOT2DVIEWER,
+#   SALOME_USE_GRAPHICSVIEW, SALOME_USE_QXGRAPHVIEWER, SALOME_USE_PVVIEWER, SALOME_USE_PYVIEWER,
+#   SALOME_USE_PYCONSOLE, SALOME_USE_SALOMEOBJECT
+#
+# Example of usage:
+#   SALOME_GUI_MODE(SALOME_USE_OCCVIEWER SALOME_USE_SALOMEOBJECT OPTIONAL SALOME_USE_PYCONSOLE)
 #
 MACRO(SALOME_GUI_MODE)
   MESSAGE(STATUS "")