[Orxonox-commit 639] r3171 - in branches/pch/doc: . api

rgrieder at orxonox.net rgrieder at orxonox.net
Sun Jun 14 20:31:17 CEST 2009 

Author: rgrieder
Date: 2009-06-14 20:31:17 +0200 (Sun, 14 Jun 2009)
New Revision: 3171

Added:
   branches/pch/doc/api/dot/
   branches/pch/doc/api/examples/
   branches/pch/doc/api/images/
   branches/pch/doc/api/main.dox
Removed:
   branches/pch/doc/examples/
   branches/pch/doc/images/
Modified:
   branches/pch/doc/api/CMakeLists.txt
   branches/pch/doc/api/doxy.config.in
Log:
Merged Gruppenarbeit changes regarding Doxygen: Don't worry, I haven't actually changed any Doxygen option, just a little clean up.

Modified: branches/pch/doc/api/CMakeLists.txt
===================================================================
--- branches/pch/doc/api/CMakeLists.txt	2009-06-14 16:39:17 UTC (rev 3170)
+++ branches/pch/doc/api/CMakeLists.txt	2009-06-14 18:31:17 UTC (rev 3171)
@@ -49,8 +49,9 @@
     CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in ${CMAKE_CURRENT_BINARY_DIR}/doxy.config @ONLY)
     # use (configured) doxy.config from (out of place) BUILD tree:
     SET(DOXY_CONFIG ${CMAKE_CURRENT_BINARY_DIR}/doxy.config)
+    SET(DOXY_LOGFILE ${CMAKE_CURRENT_BINARY_DIR}/doxy.log)
   ELSE()
-    MESSAGE(STATUS "Warning: Could not find dox.config.in in the root directory.")
+    MESSAGE(FATAL_ERROR "Warning: Could not find dox.config.in in the root directory.")
   ENDIF()
   
   ADD_CUSTOM_TARGET(doc ${DOXYGEN_EXECUTABLE} ${DOXY_CONFIG})
@@ -63,10 +64,10 @@
     IF(HTML_HELP_COMPILER)      
       SET(TMP ${DOXY_OUTPUT_DIR}/html/index.hhp)
       STRING(REGEX REPLACE "/" "\\\\" HHP_FILE ${TMP})
-      ADD_CUSTOM_TARGET(chmdoc ${HTML_HELP_COMPILER} ${HHP_FILE})
-      ADD_DEPENDENCIES(chmdoc doc)
+      ADD_CUSTOM_TARGET(doc_chm ${HTML_HELP_COMPILER} ${HHP_FILE})
+      ADD_DEPENDENCIES(doc_chm doc)
       # Adding a dependency somehow adds doc target as default build target
-      SET_TARGET_PROPERTIES(doc chmdoc PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD TRUE)
+      SET_TARGET_PROPERTIES(doc doc_chm PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD TRUE)
     ENDIF(HTML_HELP_COMPILER)
   ENDIF (WIN32) 
 
@@ -77,7 +78,7 @@
     DESTINATION ${ORXONOX_DOC_INSTALL_PATH}/api
     OPTIONAL
   )
-  # Install command always needs the directory to work
+  # Install command always needs the directory
   IF(NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/html)
     FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html)
   ENDIF()

Modified: branches/pch/doc/api/doxy.config.in
===================================================================
--- branches/pch/doc/api/doxy.config.in	2009-06-14 16:39:17 UTC (rev 3170)
+++ branches/pch/doc/api/doxy.config.in	2009-06-14 18:31:17 UTC (rev 3171)
@@ -53,16 +53,6 @@
 
 OUTPUT_LANGUAGE        = English
 
-# This tag can be used to specify the encoding used in the generated output. 
-# The encoding is not always determined by the language that is chosen, 
-# but also whether or not the output is meant for Windows or non-Windows users. 
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
-# forces the Windows encoding (this is the default for the Windows binary), 
-# whereas setting the tag to NO uses a Unix-style encoding (the default for 
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING   = YES
-
 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
 # include brief member descriptions after the members that are listed in 
 # the file and class documentation (similar to JavaDoc). 
@@ -376,7 +366,7 @@
 # The ENABLED_SECTIONS tag can be used to enable conditional 
 # documentation sections, marked by \if sectionname ... \endif.
 
-ENABLED_SECTIONS       = 
+ENABLED_SECTIONS       = YES
 
 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
 # the initial value of a variable or define consists of for it to appear in 
@@ -400,6 +390,18 @@
 
 SHOW_DIRECTORIES       = YES
 
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the Folder
+# Tree View (if specified). The default is YES.
+
+SHOW_FILES             = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES        = YES
+
 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
 # doxygen should invoke to get the current version for each file (typically from the 
 # version control system). Doxygen will invoke the program by executing (via 
@@ -459,7 +461,7 @@
 # and error messages should be written. If left blank the output is written 
 # to stderr.
 
-WARN_LOGFILE           = @DOXY_OUTPUT_DIR@/doxy.log
+WARN_LOGFILE           = @DOXY_LOGFILE@
 
 #---------------------------------------------------------------------------
 # configuration options related to the input files
@@ -471,6 +473,7 @@
 # with spaces.
 
 INPUT                  = @CMAKE_SOURCE_DIR@/src \
+                         @CMAKE_CURRENT_SOURCE_DIR@ \
                          @CMAKE_BINARY_DIR@/src
 
 # If the value of the INPUT tag contains directories, you can use the 
@@ -517,7 +520,7 @@
 # directories that contain example code fragments that are included (see 
 # the \include command).
 
-EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@/doc/examples/
+EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples/
 
 # 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 
@@ -541,7 +544,7 @@
 # directories that contain image that are included in the documentation (see 
 # the \image command).
 
-IMAGE_PATH             = @CMAKE_SOURCE_DIR@/doc/images/
+IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images/
 
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
@@ -1029,7 +1032,7 @@
 # undefined via #undef or recursively expanded use the := operator 
 # instead of the = operator.
 
-PREDEFINED             = 
+PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
 # this tag can be used to specify a list of macro names that should be expanded. 
@@ -1139,7 +1142,6 @@
 # Language.
 
 UML_LOOK               = NO
-# UML_LOOK               = YES
 
 # If set to YES, the inheritance and collaboration graphs will show the 
 # relations between templates and their instances.
@@ -1195,7 +1197,7 @@
 # contain dot files that are included in the documentation (see the 
 # \dotfile command).
 
-DOTFILE_DIRS           = 
+DOTFILE_DIRS           = @CMAKE_CURRENT_SOURCE_DIR@/dot
 
 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
@@ -1221,8 +1223,7 @@
 # files in one run (i.e. multiple -o and -T options on the command line). This 
 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
 # support this, this feature is disabled by default.
-# JW
-# DOT_MULTI_TARGETS      = NO
+
 DOT_MULTI_TARGETS      = NO
 
 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
@@ -1244,5 +1245,4 @@
 # The SEARCHENGINE tag specifies whether or not a search engine should be 
 # used. If set to NO the values of all tags below this one will be ignored.
 
-# JW SEARCHENGINE           = NO
 SEARCHENGINE           = YES

Added: branches/pch/doc/api/main.dox
===================================================================
--- branches/pch/doc/api/main.dox	                        (rev 0)
+++ branches/pch/doc/api/main.dox	2009-06-14 18:31:17 UTC (rev 3171)
@@ -0,0 +1,4 @@
+/**
+ at mainpage
+    Orxonox Doxygen Reference
+*/

More information about the Orxonox-commit mailing list