summaryrefslogtreecommitdiffstats
path: root/Modules/Documentation.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'Modules/Documentation.cmake')
-rw-r--r--Modules/Documentation.cmake33
1 files changed, 33 insertions, 0 deletions
diff --git a/Modules/Documentation.cmake b/Modules/Documentation.cmake
new file mode 100644
index 0000000..c86e704
--- /dev/null
+++ b/Modules/Documentation.cmake
@@ -0,0 +1,33 @@
+# DocumentationVTK.cmake
+#
+# This file provides support for the VTK documentation framework.
+# It relies on several tools (Doxygen, Perl, etc).
+
+#
+# Build the documentation ?
+#
+OPTION(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
+
+IF (BUILD_DOCUMENTATION)
+
+ #
+ # Check for the tools
+ #
+ INCLUDE(${CMAKE_ROOT}/Modules/FindUnixCommands.cmake)
+ INCLUDE(${CMAKE_ROOT}/Modules/FindDoxygen.cmake)
+ INCLUDE(${CMAKE_ROOT}/Modules/FindHhc.cmake)
+ INCLUDE(${CMAKE_ROOT}/Modules/FindPerl.cmake)
+ INCLUDE(${CMAKE_ROOT}/Modules/FindWget.cmake)
+
+ OPTION(DOCUMENTATION_HTML_HELP
+ "Build the HTML Help file (CHM)." OFF)
+
+ OPTION(DOCUMENTATION_HTML_TARZ
+ "Build a compressed tar archive of the HTML doc." OFF)
+
+ #
+ # The documentation process is controled by a batch file.
+ # We will probably need bash to create the custom target
+ #
+
+ENDIF (BUILD_DOCUMENTATION)