]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update a comment in the doxygen options file. 8239/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Sat, 18 May 2019 11:36:25 +0000 (05:36 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sat, 18 May 2019 11:36:25 +0000 (05:36 -0600)
doc/doxygen/options.dox.in

index 133ed43761fe191e24b91e1084b96d45831f2ea7..832764b0db9300dcce438f754b01fd6a9e41ece3 100644 (file)
@@ -158,11 +158,14 @@ SEARCH_INCLUDES        = YES
 INCLUDE_PATH           = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include @_inst_in_dirs@
 INCLUDE_FILE_PATTERNS  =
 
-# set a few variables that help us generate documentation for
-# things like the PETSc and Trilinos wrappers, even if they were
-# not configured
+# Set a few variables that help us generate documentation for things
+# like the PETSc and Trilinos wrappers, even if they were not
+# configured. We want to do that because we want the documentation to
+# reflect the most complete picture of the library, even if the system
+# on which the documentation was built doesn't actually have all
+# possible dependencies installed.
 #
-# in the case of DEAL_II_NAMESPACE_OPEN/CLOSE, just expand them
+# In the case of DEAL_II_NAMESPACE_OPEN/CLOSE, just expand them
 # to nothing so that they don't show up in the documentation
 # at all.
 PREDEFINED             = DOXYGEN=1 \

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.