[Orxonox-commit 2601] r7306 - in code/branches/doc: doc/api src

[landauf at orxonox.net]

Author: landauf
Date: 2010-09-01 00:46:06 +0200 (Wed, 01 Sep 2010)
New Revision: 7306

Modified:
   code/branches/doc/doc/api/doxy.config.in
   code/branches/doc/src/OrxonoxConfig.h.in
   code/branches/doc/src/SpecialConfig.h.in
Log:
modified doxy.config.in

moved the comments for some defines in OrxonoxConfig.h.in and SpecialConfig.h.in on the same line as the define to avoid problems with Doxygen if the define is disabled by CMake.

Modified: code/branches/doc/doc/api/doxy.config.in
===================================================================
--- code/branches/doc/doc/api/doxy.config.in	2010-08-31 22:04:57 UTC (rev 7305)
+++ code/branches/doc/doc/api/doxy.config.in	2010-08-31 22:46:06 UTC (rev 7306)
@@ -423,7 +423,7 @@
 
 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
 
-SORT_MEMBERS_CTORS_1ST = NO
+SORT_MEMBERS_CTORS_1ST = YES
 
 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
 # hierarchy of group names into alphabetical order. If set to NO (the default)
@@ -439,7 +439,7 @@
 # Note: This option applies only to the class list, not to the
 # alphabetical list.
 
-SORT_BY_SCOPE_NAME     = NO
+SORT_BY_SCOPE_NAME     = YES
 
 # The GENERATE_TODOLIST tag can be used to enable (YES) or
 # disable (NO) the todo list. This list is created by putting \todo
@@ -621,7 +621,9 @@
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external/bullet/
+EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external/bullet/ \
+                         @CMAKE_SOURCE_DIR@/src/external/cpptcl/ \
+                         @CMAKE_SOURCE_DIR@/src/libraries/tools/bsp
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -643,7 +645,7 @@
 # wildcard * is used, a substring. Examples: ANamespace, AClass,
 # AClass::ANamespace, ANamespace::*Test
 
-EXCLUDE_SYMBOLS        =
+EXCLUDE_SYMBOLS        = orxonox::detail
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or
 # directories that contain example code fragments that are included (see

Modified: code/branches/doc/src/OrxonoxConfig.h.in
===================================================================
--- code/branches/doc/src/OrxonoxConfig.h.in	2010-08-31 22:04:57 UTC (rev 7305)
+++ code/branches/doc/src/OrxonoxConfig.h.in	2010-08-31 22:46:06 UTC (rev 7306)
@@ -144,8 +144,7 @@
 /*---------------------------------
  * Options
  *-------------------------------*/
-/// Enables expensive (build time) optimisations and disables certain features
-#cmakedefine ORXONOX_RELEASE
+#cmakedefine ORXONOX_RELEASE  ///< Enables expensive (build time) optimisations and disables certain features
 
 
 /*---------------------------------

Modified: code/branches/doc/src/SpecialConfig.h.in
===================================================================
--- code/branches/doc/src/SpecialConfig.h.in	2010-08-31 22:04:57 UTC (rev 7305)
+++ code/branches/doc/src/SpecialConfig.h.in	2010-08-31 22:46:06 UTC (rev 7306)
@@ -42,17 +42,13 @@
 #include "OrxonoxConfig.h"
 #include <boost/preprocessor/stringize.hpp>
 
-/// Set whether we must suffix "ceguilua/" for the CEGUILua.h include
-#cmakedefine CEGUILUA_USE_INTERNAL_LIBRARY
+#cmakedefine CEGUILUA_USE_INTERNAL_LIBRARY  ///< Set whether we must suffix "ceguilua/" for the CEGUILua.h include
 
-/// Defined if a precompiled depdency package was used. We then copy all libraries too when installing.
-#cmakedefine DEPENDENCY_PACKAGE_ENABLE
+#cmakedefine DEPENDENCY_PACKAGE_ENABLE      ///< Defined if a precompiled depdency package was used. We then copy all libraries too when installing.
 
-/// Orxonox either gets installed to the system or just into a folder. The latter uses relative paths.
-#cmakedefine INSTALL_COPYABLE
+#cmakedefine INSTALL_COPYABLE               ///< Orxonox either gets installed to the system or just into a folder. The latter uses relative paths.
 
-/// Using MSVC or XCode IDE
-#cmakedefine CMAKE_CONFIGURATION_TYPES
+#cmakedefine CMAKE_CONFIGURATION_TYPES      ///< Using MSVC or XCode IDE
 
 // Handle default ConfigValues
 namespace orxonox { namespace specialConfig
@@ -111,7 +107,6 @@
 #endif
 } }
 
-/// Use main() or WinMain()?
-#cmakedefine ORXONOX_USE_WINMAIN
+#cmakedefine ORXONOX_USE_WINMAIN  ///< Using MSVC or XCode IDE
 
 #endif /* _SpecialConfig_H__ */