]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Several bugfixes in the documentation generation
authormaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 15 Jan 2013 13:23:35 +0000 (13:23 +0000)
committermaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 15 Jan 2013 13:23:35 +0000 (13:23 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_cmake@28064 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/CMakeLists.txt
deal.II/doc/doxygen/CMakeLists.txt
deal.II/doc/doxygen/options.dox.in
deal.II/doc/doxygen/tutorial/CMakeLists.txt
deal.II/doc/doxygen/tutorial/_plain.snippet.in
deal.II/doc/doxygen/tutorial/_toc.intro.snippet.in

index 1c3462eb3ff90e6ad9bb2b37bf9115ff659307e5..d3565b18d47f6daa6a48cb7ff7551369c8556f11 100644 (file)
@@ -29,8 +29,9 @@ IF(DEAL_II_COMPONENT_DOCUMENTATION)
   INSTALL(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
     DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}
     COMPONENT documentation
-    PATTERN "doxygen" EXCLUDE
     PATTERN "CMakeLists.txt" EXCLUDE
+    PATTERN "doxygen" EXCLUDE
+    PATTERN "*.in" EXCLUDE
     )
 
   CONFIGURE_FILE(
index 630641aed6962ac11f5302283ccc5786fe8afc69..450b4df1d75f76de2d77245ba049dc79b1f2b3ae 100644 (file)
@@ -62,21 +62,23 @@ CONFIGURE_FILE(
 #
 
 file(GLOB doxygen_input
-  ${CMAKE_SOURCE_DIR}/include/deal.II/**/*.h
-  ${CMAKE_BINARY_DIR}/include/deal.II/**/*.h
   ${CMAKE_CURRENT_SOURCE_DIR}/headers/*.h
-  ${CMAKE_CURRENT_BINARY_DIR}/tutorial/*.h
-  ${CMAKE_SOURCE_DIR}/doc/news/*.h
   ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/*.h
   ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/main.cpp
+  ${CMAKE_SOURCE_DIR}/doc/news/*.h
+  ${CMAKE_SOURCE_DIR}/include/deal.II/**/*.h
+
+  ${CMAKE_BINARY_DIR}/include/deal.II/base/config.h
+  ${CMAKE_CURRENT_BINARY_DIR}/tutorial
   )
 TO_STRING(doxygen_input_string ${doxygen_input})
 
 file(GLOB doxygen_image_path
   ${CMAKE_CURRENT_SOURCE_DIR}/images
-  ${CMAKE_CURRENT_BINARY_DIR}/images
   ${CMAKE_SOURCE_DIR}/examples/*/doc
   ${CMAKE_SOURCE_DIR}/contrib/parameter_gui/images
+
+  ${CMAKE_CURRENT_BINARY_DIR}/images
   )
 TO_STRING(doxygen_image_path_string ${doxygen_image_path})
 
index e3ec767bf4c4989c47c35959f9b6d4c4ad481832..a5cf8929b1d57b788698ad24125f899a02fdfae1 100644 (file)
@@ -477,7 +477,7 @@ EXCLUDE_PATTERNS       = *.templates.h
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@/examples/doxygen @CMAKE_BINARY_DIR@/doc/doxygen/tutorial
+EXAMPLE_PATH           = @CMAKE_BINARY_DIR@/doc/doxygen/tutorial
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
index aed040f133fdd3510d91e3fe205f9f86ba7f1f9e..a4d7c2e9748bb430b434b751aa67f2cf732a63f0 100644 (file)
@@ -17,7 +17,7 @@
 # Prepare steps.png and steps.cmapx:
 #
 
-file(GLOB steps
+file(GLOB _steps
   ${CMAKE_SOURCE_DIR}/examples/step-*
   )
 
@@ -26,7 +26,7 @@ ADD_CUSTOM_COMMAND(
   COMMAND ${PERL_EXECUTABLE}
   ARGS
     ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/steps.pl
-    ${steps}
+    ${_steps}
     > ${CMAKE_CURRENT_BINARY_DIR}/steps.dot
   )
 
@@ -87,29 +87,29 @@ ADD_CUSTOM_TARGET(tutorial
 # Prepare the steps for documentation generation
 #
 
-FOREACH(step ${steps})
-  GET_FILENAME_COMPONENT(step "${step}" NAME)
-  STRING(REGEX REPLACE "-" "_" step_underscore "${step}")
+FOREACH(_step ${_steps})
+  GET_FILENAME_COMPONENT(_step "${_step}" NAME)
+  STRING(REGEX REPLACE "-" "_" _step_underscore "${_step}")
 
   CONFIGURE_FILE(
     ${CMAKE_CURRENT_SOURCE_DIR}/_toc.intro.snippet.in
-    ${CMAKE_CURRENT_BINARY_DIR}/${step}_toc.intro.snippet
+    ${CMAKE_CURRENT_BINARY_DIR}/${_step}_toc.intro.snippet
     )
 
   CONFIGURE_FILE(
     ${CMAKE_CURRENT_SOURCE_DIR}/_plain.snippet.in
-    ${CMAKE_CURRENT_BINARY_DIR}/${step}_plain.snippet
+    ${CMAKE_CURRENT_BINARY_DIR}/${_step}_plain.snippet
     )
 
   ADD_CUSTOM_COMMAND(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${step}.cc
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${_step}.cc
     COMMAND ${PERL_EXECUTABLE}
     ARGS
       ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/program2plain
-      < ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.cc
+      < ${CMAKE_SOURCE_DIR}/examples/${_step}/${_step}.cc
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.cc
     DEPENDS
-      ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc
+      ${CMAKE_SOURCE_DIR}/examples/${_step}/${_step}.cc
     VERBATIM
     )
 
@@ -117,71 +117,71 @@ FOREACH(step ${steps})
     #
     # This has to be refactored really, really badly...
     #
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND cat
     ARGS
-      ${CMAKE_CURRENT_BINARY_DIR}/${step}_toc.intro.snippet
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      ${CMAKE_CURRENT_BINARY_DIR}/${_step}_toc.intro.snippet
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND ${PERL_EXECUTABLE}
     ARGS
       ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/intro2toc
-      < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/intro.dox
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      < ${CMAKE_SOURCE_DIR}/examples/${_step}/doc/intro.dox
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND cat
     ARGS
       ${CMAKE_CURRENT_SOURCE_DIR}/_toc.prog.snippet
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND ${PERL_EXECUTABLE}
     ARGS
       ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/program2toc
-      < ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      < ${CMAKE_SOURCE_DIR}/examples/${_step}/${_step}.cc
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND cat
     ARGS
       ${CMAKE_CURRENT_SOURCE_DIR}/_toc.results.snippet
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND ${PERL_EXECUTABLE}
     ARGS
       ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/intro2toc
-      < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/results.dox
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      < ${CMAKE_SOURCE_DIR}/examples/${_step}/doc/results.dox
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND cat
     ARGS
       ${CMAKE_CURRENT_SOURCE_DIR}/_toc.final.snippet
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND ${PERL_EXECUTABLE}
     ARGS
       ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/create_anchors
-      < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/intro.dox
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      < ${CMAKE_SOURCE_DIR}/examples/${_step}/doc/intro.dox
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND ${PERL_EXECUTABLE}
     ARGS
       ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/program2doxygen
-      < ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      < ${CMAKE_SOURCE_DIR}/examples/${_step}/${_step}.cc
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND ${PERL_EXECUTABLE}
     ARGS
       ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/create_anchors
-      < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/results.dox
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      < ${CMAKE_SOURCE_DIR}/examples/${_step}/doc/results.dox
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     COMMAND cat
     ARGS
-      ${CMAKE_CURRENT_BINARY_DIR}/${step}_plain.snippet
-      >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
+      ${CMAKE_CURRENT_BINARY_DIR}/${_step}_plain.snippet
+      >> ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
     WORKING_DIRECTORY
       ${CMAKE_CURRENT_BINARY_DIR}
     DEPENDS
-      ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc
-      ${CMAKE_SOURCE_DIR}/examples/${step}/doc/intro.dox
-      ${CMAKE_SOURCE_DIR}/examples/${step}/doc/results.dox
+      ${CMAKE_SOURCE_DIR}/examples/${_step}/${_step}.cc
+      ${CMAKE_SOURCE_DIR}/examples/${_step}/doc/intro.dox
+      ${CMAKE_SOURCE_DIR}/examples/${_step}/doc/results.dox
     VERBATIM
     )
-  ADD_CUSTOM_TARGET(tutorial_${step}
+  ADD_CUSTOM_TARGET(tutorial_${_step}
     DEPENDS
-      ${CMAKE_CURRENT_BINARY_DIR}/${step}.h
-      ${CMAKE_CURRENT_BINARY_DIR}/${step}.cc
+      ${CMAKE_CURRENT_BINARY_DIR}/${_step}.h
+      ${CMAKE_CURRENT_BINARY_DIR}/${_step}.cc
     )
-  ADD_DEPENDENCIES(tutorial tutorial_${step})
+  ADD_DEPENDENCIES(tutorial tutorial_${_step})
 ENDFOREACH()
 
 
@@ -200,3 +200,4 @@ INSTALL(FILES
   DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR}/doxygen/tutorial
   COMPONENT documentation
   )
+
index 4c301e7158f92388261f32f66fcb12a0934653f2..f94ec1b6b54cde4f62e8a779b460dd4c9b533b3a 100644 (file)
@@ -1,4 +1,4 @@
 <a name="PlainProg"></a>
 <h1> The plain program</h1>
-@include "${step}.cc"
+@include "${_step}.cc"
  */
index 81d35a5b047812e3d3c5f093423437731e1c941d..c47655406372c7312048a24361e08c923246004c 100644 (file)
@@ -1,5 +1,5 @@
 /**
-  * @page ${step_underscore} The ${step} tutorial program
+  * @page ${_step_underscore} The ${_step} tutorial program
 @htmlonly
 <table class="tutorial" width="50%">
 <tr><th colspan="2"><b><small>Table of contents</small></b></th></tr>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.