[QGIS Commit] r9090 - trunk/qgis/src/core

[svn_qgis at osgeo.org]

Author: timlinux
Date: 2008-08-20 07:49:11 -0400 (Wed, 20 Aug 2008)
New Revision: 9090

Modified:
   trunk/qgis/src/core/qgsapplication.h
   trunk/qgis/src/core/qgsattributeaction.h
   trunk/qgis/src/core/qgsclipper.h
   trunk/qgis/src/core/qgscontexthelp.h
   trunk/qgis/src/core/qgscoordinatetransform.h
   trunk/qgis/src/core/qgscsexception.h
   trunk/qgis/src/core/qgsdataprovider.h
   trunk/qgis/src/core/qgsdatasourceuri.h
Log:
Api documentation updates and setting grouping tag

Modified: trunk/qgis/src/core/qgsapplication.h
===================================================================
--- trunk/qgis/src/core/qgsapplication.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgsapplication.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -18,6 +18,10 @@
 
 #include <QApplication>
 
+/** \ingroup core
+ * Extends QApplication to provide access to QGIS specific resources such
+ * as theme paths, database paths etc.
+ */
 class CORE_EXPORT QgsApplication: public QApplication
 {
   public:

Modified: trunk/qgis/src/core/qgsattributeaction.h
===================================================================
--- trunk/qgis/src/core/qgsattributeaction.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgsattributeaction.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -36,8 +36,8 @@
 class QDomDocument;
 
 
-/*! \class QgsAction
- * \brief Utility class that encapsulates an action and associated information
+/** \ingroup core
+ * Utility class that encapsulates an action based on vector attributes.
  */
 class CORE_EXPORT QgsAction
 {

Modified: trunk/qgis/src/core/qgsclipper.h
===================================================================
--- trunk/qgis/src/core/qgsclipper.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgsclipper.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -27,14 +27,16 @@
 #include <cmath>
 #include <iostream>
 
-// The functions in this class are likely to be called from within a
-// render loop and hence need to as CPU efficient as possible. 
+/** \ingroup core
+ * A class to trim lines and polygons to within a rectangular region.
+ * The functions in this class are likely to be called from within a
+ * render loop and hence need to as CPU efficient as possible. 
+ * The main purpose of the functions in this class are to trim lines
+ *  and polygons to lie within a rectangular region. This is necessary
+ *  for drawing items to an X11 display which have a limit on the
+ *   magnitude of the screen coordinates (+/- 32768, i.e. 16 bit integer).
+ */
 
-// The main purpose of the functions in this class are to trim lines
-// and polygons to lie within a rectangular region. This is necessary
-// for drawing items to an X11 display which have a limit on the
-// magnitude of the screen coordinates (+/- 32768, i.e. 16 bit integer).
-
 class CORE_EXPORT QgsClipper
 {
  public:

Modified: trunk/qgis/src/core/qgscontexthelp.h
===================================================================
--- trunk/qgis/src/core/qgscontexthelp.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgscontexthelp.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -27,9 +27,8 @@
 #ifdef Q_OS_MACX
 #define QGSCONTEXTHELP_REUSE 1
 #endif
-/*!
- * \class QgsContextHelp
- * \brief Provides a context based help browser for a dialog.
+/** \ingroup core
+ * Provides a context based help browser for a dialog.
  *
  * The help text is stored in SQLite and accessed by a context identifier
  * unique to each dialog. This is a singleton class which invokes the help

Modified: trunk/qgis/src/core/qgscoordinatetransform.h
===================================================================
--- trunk/qgis/src/core/qgscoordinatetransform.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgscoordinatetransform.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -36,10 +36,10 @@
 typedef void* projPJ;
 class QString;
 
-/*! \class QgsCoordinateTransform
-* \brief Class for doing transforms between two map coordinate systems.
+/** \ingroup core
+* Class for doing transforms between two map coordinate systems.
 *
-* This class can convert map coordinates to a different spatial reference system.
+* This class can convert map coordinates to a different coordinate reference system.
 * It is normally associated with a map layer and is used to transform between the
 * layer's coordinate system and the coordinate system of the map canvas, although
 * it can be used in a more general sense to transform coordinates.

Modified: trunk/qgis/src/core/qgscsexception.h
===================================================================
--- trunk/qgis/src/core/qgscsexception.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgscsexception.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -19,6 +19,9 @@
 #define QGSCSEXCEPTION_H
 
 #include "qgsexception.h"
+/** \ingroup core
+ * Custom exception class for Coordinate Reference System related exceptions.
+ */
 class CORE_EXPORT QgsCsException : public QgsException
 {
   public:

Modified: trunk/qgis/src/core/qgsdataprovider.h
===================================================================
--- trunk/qgis/src/core/qgsdataprovider.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgsdataprovider.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -26,8 +26,8 @@
 class QgsSpatialRefSys;
 
 
-/** \class QgsDataProvider
- * \brief Abstract base class for spatial data provider implementations
+/** \ingroup core
+ * Abstract base class for spatial data provider implementations.
  * @author Gary E.Sherman
  * 
  * This object needs to inherit from QObject to enable event 

Modified: trunk/qgis/src/core/qgsdatasourceuri.h
===================================================================
--- trunk/qgis/src/core/qgsdatasourceuri.h	2008-08-20 11:36:43 UTC (rev 9089)
+++ trunk/qgis/src/core/qgsdatasourceuri.h	2008-08-20 11:49:11 UTC (rev 9090)
@@ -22,12 +22,10 @@
 
 #include <QString> 
 
-/** 
-\struct QgsDataSourceURI 
-\brief Structure for storing the component parts of a PostgreSQL/RDBMS datasource URI.
-           
- This structure stores the database connection information, including host, database,
-  user name, password, schema, password, and sql where clause
+/** \ingroup core
+ * Class for storing the component parts of a PostgreSQL/RDBMS datasource URI.
+ * This structure stores the database connection information, including host, database,
+ * user name, password, schema, password, and sql where clause
  */
 class CORE_EXPORT QgsDataSourceURI
 {