[QGIS Commit] r9088 - in trunk/qgis: . doc src/core

[svn_qgis at osgeo.org]

Author: timlinux
Date: 2008-08-20 07:25:42 -0400 (Wed, 20 Aug 2008)
New Revision: 9088

Modified:
   trunk/qgis/Doxyfile
   trunk/qgis/doc/modules.dox
   trunk/qgis/src/core/qgis.h
Log:
Use javadoc style class descriptors and updated modules list

Modified: trunk/qgis/Doxyfile
===================================================================
--- trunk/qgis/Doxyfile	2008-08-20 10:02:19 UTC (rev 9087)
+++ trunk/qgis/Doxyfile	2008-08-20 11:25:42 UTC (rev 9088)
@@ -150,7 +150,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 /// 

Modified: trunk/qgis/doc/modules.dox
===================================================================
--- trunk/qgis/doc/modules.dox	2008-08-20 10:02:19 UTC (rev 9087)
+++ trunk/qgis/doc/modules.dox	2008-08-20 11:25:42 UTC (rev 9088)
@@ -1,4 +1,5 @@
 /** @defgroup library */
 /** @defgroup gui */
 /** @defgroup core*/
+/** @defgroup MapComposer*/
 /** @defgroup UnitTests*/

Modified: trunk/qgis/src/core/qgis.h
===================================================================
--- trunk/qgis/src/core/qgis.h	2008-08-20 10:02:19 UTC (rev 9087)
+++ trunk/qgis/src/core/qgis.h	2008-08-20 11:25:42 UTC (rev 9088)
@@ -18,20 +18,11 @@
 
 #ifndef QGIS_H
 #define QGIS_H
-/*!  \mainpage Quantum GIS
-*
-*  \section about  About QGIS
-* Quantum GIS (QGIS) is a user friendly Open Source Geographic Information
-* System (GIS) that runs on Linux, Unix, Mac OSX, and Windows. QGIS supports
-* vector, raster, and database formats. QGIS is licensed under the GNU Public
-* License.
-*
-* This API documentation provides information about all classes that make up QGIS.
-*/
-
 #include <QEvent>
 #include <QString>
-
+/** \ingroup core
+ * The QGis class provides global constants for use throughout the application.
+ */
 class CORE_EXPORT QGis
 { 
 public: