Changeset 6412 for code/branches/pickup2/doc/api

Timestamp:

Dec 25, 2009, 1:18:03 PM (15 years ago)

Author:

dafrick

Message:

Merged presentation2 branch into pickup2 branch.

Location:

code/branches/pickup2

Files:

• . (modified) (1 prop)
• doc/api/CMakeLists.txt (modified) (7 diffs)
• doc/api/doxy.config.in (modified) (4 diffs)
• doc/api/main.dox (modified) (1 prop)

code/branches/pickup2/doc/api/CMakeLists.txt

@@ -1 @@
-# Add a "doc" target with CMake build system. 
+# Add a "doc" target with CMake build system.
 # And configure doxy.config.in to doxy.config
 #
 # target "doc" allows building the documentation with doxygen/dot on WIN32 and Linux
-# Creates .chm windows help file if MS HTML help workshop 
+# Creates .chm windows help file if MS HTML help workshop
 # (available from http://msdn.microsoft.com/workshop/author/htmlhelp)
 # is installed with its DLLs in PATH.
@@ -12 +12 @@
 # must be in path.
 #
-# Note about Visual Studio Projects: 
+# Note about Visual Studio Projects:
 # MSVS hast its own path environment which may differ from the shell.
 # See "Menu Tools/Options/Projects/VC++ Directories" in VS 7.1
@@ -32 +32 @@
   SET(DOXY_INPUT_DIR  ${CMAKE_CURRENT_SOURCE_DIR})
   SET(DOXY_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR})
-  
+
   # we need latex for doxygen because of the formulas
   # Orxonox doesn't
@@ -45 +45 @@
   #  MESSAGE(STATUS "dvips command DVIPS_CONVERTER not found but usually required.")
   #ENDIF (NOT DVIPS_CONVERTER)
-  
+
   IF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in)
     CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in ${CMAKE_CURRENT_BINARY_DIR}/doxy.config @ONLY)
@@ -54 +54 @@
     MESSAGE(FATAL_ERROR "Warning: Could not find dox.config.in in the root directory.")
   ENDIF()
-  
+
   ADD_CUSTOM_TARGET(doc ${DOXYGEN_EXECUTABLE} ${DOXY_CONFIG})
-  
+
   # create a windows help .chm file using hhc.exe
   # HTMLHelp DLL must be in path!
@@ -62 +62 @@
   IF(WIN32)
     FIND_PACKAGE(HTMLHelp)
-    IF(HTML_HELP_COMPILER)      
+    IF(HTML_HELP_COMPILER)
       SET(TMP ${DOXY_OUTPUT_DIR}/html/index.hhp)
       STRING(REGEX REPLACE "/" "\\\\" HHP_FILE ${TMP})
@@ -70 +70 @@
       SET_TARGET_PROPERTIES(doc doc_chm PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD TRUE)
     ENDIF(HTML_HELP_COMPILER)
-  ENDIF (WIN32) 
+  ENDIF (WIN32)
 
 

code/branches/pickup2/doc/api/doxy.config.in

@@ -140 +140 @@
 # explicit @brief command for a brief description.
 
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 
 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
@@ -475 +475 @@
 INPUT                  = @CMAKE_SOURCE_DIR@/src \
                          @CMAKE_CURRENT_SOURCE_DIR@ \
-                         @CMAKE_BINARY_DIR@/src
+                         @CMAKE_BINARY_DIR@/src/OrxonoxConfig.h \
+                         @CMAKE_BINARY_DIR@/src/SpecialConfig.h
 
 # If the value of the INPUT tag contains directories, you can use the 
@@ -501 +502 @@
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = @CMAKE_SOURCE_DIR@/src/bullet/
+EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external/bullet/
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
@@ -1117 +1118 @@
 # have no effect if this option is set to NO (the default)
 
-HAVE_DOT               = @DOXYGEN_DOT_FOUND@
+HAVE_DOT               = NO
 
 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen