Skip to content

Commit

Permalink
Api documentation updates and setting grouping tag
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.osgeo.org/qgis/trunk@9090 c8812cc2-4d05-0410-92ff-de0c093fc19c
  • Loading branch information
timlinux committed Aug 20, 2008
1 parent 56e6167 commit 4969b3a
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 23 deletions.
4 changes: 4 additions & 0 deletions src/core/qgsapplication.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsattributeaction.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ class QDomNode;
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
{
Expand Down
16 changes: 9 additions & 7 deletions src/core/qgsclipper.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,15 @@
#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.

// 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).
/** \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).
*/

class CORE_EXPORT QgsClipper
{
Expand Down
5 changes: 2 additions & 3 deletions src/core/qgscontexthelp.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@ class QTcpSocket;
#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
Expand Down
6 changes: 3 additions & 3 deletions src/core/qgscoordinatetransform.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ class QDomDocument;
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.
Expand Down
3 changes: 3 additions & 0 deletions src/core/qgscsexception.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsdataprovider.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ class QgsRect;
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
Expand Down
10 changes: 4 additions & 6 deletions src/core/qgsdatasourceuri.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down

0 comments on commit 4969b3a

Please sign in to comment.