Skip to content

Commit

Permalink
Use javadoc style class descriptors and updated modules list
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.osgeo.org/qgis/trunk@9088 c8812cc2-4d05-0410-92ff-de0c093fc19c
  • Loading branch information
timlinux committed Aug 20, 2008
1 parent abdda51 commit 731ec75
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ SHORT_NAMES = NO
# 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 ///
Expand Down
1 change: 1 addition & 0 deletions doc/modules.dox
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/** @defgroup library */
/** @defgroup gui */
/** @defgroup core*/
/** @defgroup MapComposer*/
/** @defgroup UnitTests*/
15 changes: 3 additions & 12 deletions src/core/qgis.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 731ec75

Please sign in to comment.