[Orxonox-commit 1249] r5967 - code/trunk/doc/api

[rgrieder at orxonox.net]

Author: rgrieder
Date: 2009-10-19 22:52:10 +0200 (Mon, 19 Oct 2009)
New Revision: 5967

Modified:
   code/trunk/doc/api/doxy.config.in
Log:
Activated javadoc auto-brief for our doxygen documentation. This means you can do the following (4 lines):

/** A brief description.
@note
    Keep in mind!
*/

instead of the longer version (6 lines):

/**
@brief
    A brief description.
@note
    Keep in mind!
*/

Modified: code/trunk/doc/api/doxy.config.in
===================================================================
--- code/trunk/doc/api/doxy.config.in	2009-10-19 18:25:30 UTC (rev 5966)
+++ code/trunk/doc/api/doxy.config.in	2009-10-19 20:52:10 UTC (rev 5967)
@@ -139,7 +139,7 @@
 # comments will behave just like the Qt-style comments (thus requiring an 
 # 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 
 # treat a multi-line C++ special comment block (i.e. a block of //! or ///