Skip to content

Commit 731ec75

Browse files
author
timlinux
committed
Use javadoc style class descriptors and updated modules list
git-svn-id: http://svn.osgeo.org/qgis/trunk@9088 c8812cc2-4d05-0410-92ff-de0c093fc19c
1 parent abdda51 commit 731ec75

File tree

3 files changed

+5
-13
lines changed

3 files changed

+5
-13
lines changed

Doxyfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ SHORT_NAMES = NO
150150
# comments will behave just like the Qt-style comments (thus requiring an
151151
# explicit @brief command for a brief description.
152152

153-
JAVADOC_AUTOBRIEF = NO
153+
JAVADOC_AUTOBRIEF = YES
154154

155155
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
156156
# treat a multi-line C++ special comment block (i.e. a block of //! or ///

doc/modules.dox

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
/** @defgroup library */
22
/** @defgroup gui */
33
/** @defgroup core*/
4+
/** @defgroup MapComposer*/
45
/** @defgroup UnitTests*/

src/core/qgis.h

+3-12
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,11 @@
1818

1919
#ifndef QGIS_H
2020
#define QGIS_H
21-
/*! \mainpage Quantum GIS
22-
*
23-
* \section about About QGIS
24-
* Quantum GIS (QGIS) is a user friendly Open Source Geographic Information
25-
* System (GIS) that runs on Linux, Unix, Mac OSX, and Windows. QGIS supports
26-
* vector, raster, and database formats. QGIS is licensed under the GNU Public
27-
* License.
28-
*
29-
* This API documentation provides information about all classes that make up QGIS.
30-
*/
31-
3221
#include <QEvent>
3322
#include <QString>
34-
23+
/** \ingroup core
24+
* The QGis class provides global constants for use throughout the application.
25+
*/
3526
class CORE_EXPORT QGis
3627
{
3728
public:

0 commit comments

Comments
 (0)