Skip to content
Permalink
Browse files
Api documentation updates and setting grouping tag
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@9096 c8812cc2-4d05-0410-92ff-de0c093fc19c
  • Loading branch information
timlinux committed Aug 20, 2008
1 parent 57c508f commit 4146d58596f41f2c5c98e47f31f59e638b216ac4
@@ -22,15 +22,15 @@

class QgsGeometry;

/**
General purpose distance and area calculator
- calculations are done on ellipsoid
- it's possible to pass points/features in any SRS, coordinates are transformed
- two options how to use it
+ use measure() takes QgsGeometry as a parameter and calculates distance or area
+ use directly measureLine(), measurePolygon() which take list of QgsPoints
(both cases transform the coordinates from source SRS to the ellipse coords)
- returned values are in meters resp. square meters
/** \ingroup core
* General purpose distance and area calculator.
* calculations are done on ellipsoid
* it's possible to pass points/features in any CRS, coordinates are transformed
* There are two options to use it
* + use measure() takes QgsGeometry as a parameter and calculates distance or area
* + use directly measureLine(), measurePolygon() which take list of QgsPoints
* (both cases transform the coordinates from source SRS to the ellipse coords)
* Returned values are in meters resp. square meters
*/
class CORE_EXPORT QgsDistanceArea
{
@@ -24,8 +24,8 @@

#include <QDomNode>

/**
Defines a qgis exception class
/** \ingroup core
* Defines a qgis exception class.
*/
class CORE_EXPORT QgsException : public std::exception
{
@@ -40,9 +40,9 @@ typedef QMap<int, QString> QgsFieldNameMap;

typedef QList<QgsFeature> QgsFeatureList;

/**
* @class QgsFeature - Feature attribute class.
* Encapsulates a single feature including id and field/value.
/** \ingroup core
* The feature class encapsulates a single feature including its id,
* geometry and a list of field/values attributes.
*
* @author Gary E.Sherman
*/
@@ -20,12 +20,10 @@
#include <QString>
#include <QVariant>

/**
\class QgsField
\brief Class to encapsulate a field in an attribute table or data source.
QgsField stores metadata about an attribute field, including name, type
length, and if applicable, precision.
/** \ingroup core
* Encapsulate a field in an attribute table or data source.
* QgsField stores metadata about an attribute field, including name, type
* length, and if applicable, precision.
*/

class CORE_EXPORT QgsField
@@ -48,7 +48,8 @@ typedef QVector<QgsPolygon> QgsMultiPolygon;

class QgsRect;

/**
/** \ingroup core
* A geometry is the spatial representation of a feature.
* Represents a geometry with input and output in formats specified by
* (at least) the Open Geospatial Consortium (WKB / WKT), and containing
* various functions for geoprocessing of the geometry.
@@ -27,16 +27,10 @@

class QTimer;

/**
\brief HTTP request/response manager that is redirect-aware.
This class extends the Qt QHttp concept by being able to recognise
and respond to redirection responses (e.g. HTTP code 302)
TODO: Make it work
/** \ingroup core
* HTTP request/response manager that is redirect-aware.
* This class extends the Qt QHttp concept by being able to recognise
* and respond to redirection responses (e.g. HTTP code 302)
*/

class CORE_EXPORT QgsHttpTransaction : public QObject
@@ -42,7 +42,11 @@ typedef QList<int> QgsAttributeList;

typedef QMap<int, QgsField> QgsFieldMap;

/** Render class to display labels */
/** \ingroup core
* A class to render labels.
* Label rendering properties can be either specified directly or
* in most cases determined dynamically based on the value of an attribute.
**/
class CORE_EXPORT QgsLabel
{
public:
@@ -24,7 +24,8 @@
class QString;
class QColor;

/** This class can be used to store attributes needed for label rendering.
/** \ingroup core
* A class to store attributes needed for label rendering.
*
* Label attributes:
* border (color, width, style)
@@ -70,7 +71,7 @@ class QColor;
* - border color
* - border style
*
* Each attribute is either se or unset.
* Each attribute is either set or unset.
*/

class CORE_EXPORT QgsLabelAttributes
@@ -23,9 +23,8 @@
#include <iostream>

#include "qgspoint.h"

/*! \class QgsLine
* \brief A simple line object composed of a begin and end point.
/** \ingroup core
* A simple line object composed of a begin and end point.
*
* Comparisons (==, !=) honor the direction of the line. This means that
* flipped lines with the same coordinates are not considered to be equal.
@@ -31,11 +31,17 @@ __FILE__, __FUNCTION__, __LINE__);
#define QgsDebugMsgLevel(str, level)
#endif

/**QgsLogger is a class to print debug/warning/error messages to the console. The advantage of this class over std::cout, std::cerr & co. is that the output can be controlled with environment variables:
QGIS_DEBUG is an int describing what debug messages are written to the console. If the debug level of a message is <= QGIS_DEBUG, the message is written to the console. It the variable QGIS_DEBUG is not defined, it defaults to 1 for debug mode and to 0 for release mode
QGIS_DEBUG_FILE may contain a filename. Only the messages from this file are printed (provided they have the right debuglevel). If QGIS_DEBUG_FILE is not set, messages from all files are printed
/** \ingroup core
* QgsLogger is a class to print debug/warning/error messages to the console.
* The advantage of this class over std::cout, std::cerr & co. is that the
* output can be controlled with environment variables:
* QGIS_DEBUG is an int describing what debug messages are written to the console.
* If the debug level of a message is <= QGIS_DEBUG, the message is written to the
* console. It the variable QGIS_DEBUG is not defined, it defaults to 1 for debug
* mode and to 0 for release mode
* QGIS_DEBUG_FILE may contain a filename. Only the messages from this file are
* printed (provided they have the right debuglevel). If QGIS_DEBUG_FILE is not
* set, messages from all files are printed
*/

class CORE_EXPORT QgsLogger
@@ -34,9 +34,9 @@ class QDomDocument;
class QKeyEvent;
class QPainter;

/** \class QgsMapLayer
* \brief Base class for all map layer types.
* This class is the base class for all map layer types (vector, raster).
/** \ingroup core
* Base class for all map layer types.
* This is the base class for all map layer types (vector, raster).
*/
class CORE_EXPORT QgsMapLayer : public QObject
{
@@ -28,10 +28,9 @@ class QStringList;

class QgsMapLayer;

/**
* \class QgsMapLayerRegistry
* \brief This class tracks map layers that are currently loaded an provides
* a means to fetch a pointer to a map layer and delete it
/** \ingroup core
* This class tracks map layers that are currently loaded and provides
* a means to fetch a pointer to a map layer and delete it.
*/
class CORE_EXPORT QgsMapLayerRegistry : public QObject
{
@@ -34,10 +34,8 @@ class QgsScaleCalculator;
class QgsSpatialRefSys;
class QgsDistanceArea;

/**
* \class QgsMapRenderer
* \brief Class for rendering map layer set
*
/** \ingroup core
* A non GUI class for rendering a map layer set onto a QPainter.
*/

class CORE_EXPORT QgsMapRenderer : public QObject
@@ -26,11 +26,11 @@
class QgsPoint;
class QPoint;

/*! \class QgsMapToPixel
* \brief Class for doing transforms between map coordinates and device coordinates.
*
* This class can convert device coordinates to map coordinates and vice versa.
*/
/** \ingroup core
* Perform transforms between map coordinates and device coordinates.
*
* This class can convert device coordinates to map coordinates and vice versa.
*/
class CORE_EXPORT QgsMapToPixel{
public:
/* Constructor
@@ -25,17 +25,16 @@ class QgsMessageOutput;
typedef QgsMessageOutput* (*MESSAGE_OUTPUT_CREATOR)();


/**
\brief Interface for showing messages from QGIS in GUI independent way
This class provides abstraction of a dialog for showing output to the user.
By default QgsMessageConsoleOutput will be used if not overridden
with other message output creator function.
/** \ingroup core
* Interface for showing messages from QGIS in GUI independent way.
* This class provides abstraction of a dialog for showing output to the user.
* By default QgsMessageConsoleOutput will be used if not overridden with other
* message output creator function.
QGIS application uses QgsMessageView class for displaying a dialog to the user.
* QGIS application uses QgsMessageView class for displaying a dialog to the user.
Object deletes itself when it's not needed anymore. Children should use
signal destroyed() to notify the deletion
* Object deletes itself when it's not needed anymore. Children should use
* signal destroyed() to notify the deletion
*/
class CORE_EXPORT QgsMessageOutput
{
@@ -23,6 +23,10 @@

#include <QString>

/** \ingroup core
* A class to represent a point geometry.
* Currently no Z axis / 2.5D support is implemented.
*/
class CORE_EXPORT QgsPoint
{
public:

0 comments on commit 4146d58

Please sign in to comment.