Skip to content

Commit 99dd19d

Browse files
author
jef
committed
doxygen fixes
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@14319 c8812cc2-4d05-0410-92ff-de0c093fc19c
1 parent 9103ac5 commit 99dd19d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1290
-833
lines changed

‎Doxyfile

+948-558
Large diffs are not rendered by default.

‎doc/modules.dox

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
1-
/** @defgroup core
1+
/** @defgroup core QGIS core library
22

3-
QGIS core library. Contains all basic GIS functionality.
3+
Contains all basic GIS functionality.
44

55
*/
66

7-
/** @defgroup gui
7+
/** @defgroup gui QGIS gui library.
8+
9+
It's built on top of core library and adds reusable GUI widgets.
810

9-
QGIS gui library. It's built on top of core library and adds reusable GUI widgets.
1011
*/
1112

12-
/** @defgroup analysis
13+
/** @defgroup analysis QGIS analysis library.
1314

14-
Analysis library. Built on top of core library, the analysis library provides
15+
Built on top of core library, the analysis library provides
1516
high level tools for carrying out spatial analysis on vector and raster data.
1617
*/
1718

‎src/analysis/interpolation/DualEdgeTriangulation.h

+1-2
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
9292
void setTriangleInterpolator( TriangleInterpolator* interpolator );
9393
/**Eliminates the horizontal triangles by swapping or by insertion of new points*/
9494
void eliminateHorizontalTriangles();
95-
/**Adds points to make the triangles better shaped (algorithm of ruppert)
96-
\param tin the triangulation or decorator which interpolates the elevation*/
95+
/**Adds points to make the triangles better shaped (algorithm of ruppert)*/
9796
virtual void ruppertRefinement();
9897
/**Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/
9998
bool pointInside( double x, double y );

‎src/analysis/interpolation/Triangulation.h

+1-2
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ class ANALYSIS_EXPORT Triangulation
7777
virtual void setTriangleInterpolator( TriangleInterpolator* interpolator ) = 0;
7878
/**Eliminates the horizontal triangles by swapping*/
7979
virtual void eliminateHorizontalTriangles() = 0;
80-
/**Adds points to make the triangles better shaped (algorithm of ruppert)
81-
\param tin the triangulation or decorator which interpolates the elevation*/
80+
/**Adds points to make the triangles better shaped (algorithm of ruppert)*/
8281
virtual void ruppertRefinement() = 0;
8382
/**Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/
8483
virtual bool pointInside( double x, double y ) = 0;

‎src/analysis/interpolation/qgstininterpolator.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
6262

6363
/**Create dual edge triangulation*/
6464
void initialize();
65-
/**Inserts the vertices of a geometry into the triangulation
66-
@param g the geometry
65+
/**Inserts the vertices of a feature into the triangulation
66+
@param f the feature
6767
@param zCoord true if the z coordinate is the interpolation attribute
6868
@param attr interpolation attribute index (if zCoord is false)
6969
@param type point/structure line, break line

‎src/analysis/vector/qgsgeometryanalyzer.h

-6
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
4242
and write it to a new shape file
4343
@param layer input vector layer
4444
@param shapefileName path to the output shp
45-
@param fileEncoding encoding of the output file
4645
@param tolerance (level of simplification)
4746
@param onlySelectedFeatures if true, only selected features are considered, else all the features
4847
@param p progress dialog (or 0 if no progress dialog is to be shown)
@@ -54,7 +53,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
5453
write it to a new shape file
5554
@param layer input vector layer
5655
@param shapefileName path to the output shp
57-
@param fileEncoding encoding of the output file
5856
@param onlySelectedFeatures if true, only selected features are considered, else all the features
5957
@param p progress dialog (or 0 if no progress dialog is to be shown)
6058
@note: added in version 1.4*/
@@ -64,7 +62,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
6462
/**Create a polygon based on the extent of all (selected) features and write it to a new shape file
6563
@param layer input vector layer
6664
@param shapefileName path to the output shp
67-
@param fileEncoding encoding of the output file
6865
@param onlySelectedFeatures if true, only selected features are considered, else all the features
6966
@param p progress dialog (or 0 if no progress dialog is to be shown)
7067
@note: added in version 1.4*/
@@ -73,7 +70,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
7370
/**Create buffers for a vector layer and write it to a new shape file
7471
@param layer input vector layer
7572
@param shapefileName path to the output shp
76-
@param fileEncoding encoding of the output file
7773
@param bufferDistance distance for buffering (if no buffer field is specified)
7874
@param onlySelectedFeatures if true, only selected features are considered, else all the features
7975
@param dissolve if true, merge all the buffers to a big multipolygon
@@ -86,7 +82,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
8682
/**Create convex hull(s) of a vector layer and write it to a new shape file
8783
@param layer input vector layer
8884
@param shapefileName path to the output shp
89-
@param fileEncoding encoding of the output file
9085
@param onlySelectedFeatures if true, only selected features are considered, else all the features
9186
@param uniqueIdField index of the attribute field that contains the unique convex hull id (or -1 if
9287
all features have the same buffer distance)
@@ -98,7 +93,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
9893
/**Dissolve a vector layer and write it to a new shape file
9994
@param layer input vector layer
10095
@param shapefileName path to the output shp
101-
@param fileEncoding encoding of the output file
10296
@param onlySelectedFeatures if true, only selected features are considered, else all the features
10397
@param uniqueIdField index of the attribute field that contains the unique id to dissolve on (or -1 if
10498
all features should be dissolved together)

‎src/analysis/vector/qgsoverlayanalyzer.h

+48-46
Original file line numberDiff line numberDiff line change
@@ -50,52 +50,54 @@ class ANALYSIS_EXPORT QgsOverlayAnalyzer
5050
const QString& shapefileName, bool onlySelectedFeatures = false, \
5151
QProgressDialog* p = 0 );
5252

53-
// /**Perform a union of two input vector layers and write output to a new shape file
54-
// @param layerA input vector layer
55-
// @param layerB input vector layer
56-
// @param shapefileName path to the output shp
57-
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
58-
// @param p progress dialog (or 0 if no progress dialog is to be shown)
59-
// @note: added in version 1.4*/
60-
// bool combine( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
61-
// const QString& shapefileName, bool onlySelectedFeatures = false,
62-
// QProgressDialog* p = 0 );
63-
//
64-
// /**Clip a vector layer based on the boundary of another vector layer and
65-
// write output to a new shape file
66-
// @param layerA input vector layer
67-
// @param layerB input vector layer
68-
// @param shapefileName path to the output shp
69-
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
70-
// @param p progress dialog (or 0 if no progress dialog is to be shown)
71-
// @note: added in version 1.4*/
72-
// bool clip( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
73-
// const QString& shapefileName, bool onlySelectedFeatures = false,
74-
// QProgressDialog* p = 0 );
75-
//
76-
// /**Difference a vector layer based on the geometries of another vector layer
77-
// and write the output to a new shape file
78-
// @param layerA input vector layer
79-
// @param layerB input vector layer
80-
// @param shapefileName path to the output shp
81-
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
82-
// @param p progress dialog (or 0 if no progress dialog is to be shown)
83-
// @note: added in version 1.4*/
84-
// bool difference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
85-
// const QString& shapefileName, bool onlySelectedFeatures = false,
86-
// QProgressDialog* p = 0 );
87-
//
88-
// /**Intersect two vector layers and write the geometries of each layer that
89-
// do not intersect with the other layer to a new shape file (Symmetrical difference)
90-
// @param layerA input vector layer
91-
// @param layerB input vector layer
92-
// @param shapefileName path to the output shp
93-
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
94-
// @param p progress dialog (or 0 if no progress dialog is to be shown)
95-
// @note: added in version 1.4*/
96-
// bool symDifference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
97-
// const QString& shapefileName, bool onlySelectedFeatures = false,
98-
// QProgressDialog* p = 0 );
53+
#if 0
54+
/**Perform a union of two input vector layers and write output to a new shape file
55+
@param layerA input vector layer
56+
@param layerB input vector layer
57+
@param shapefileName path to the output shp
58+
@param onlySelectedFeatures if true, only selected features are considered, else all the features
59+
@param p progress dialog (or 0 if no progress dialog is to be shown)
60+
@note: added in version 1.4*/
61+
bool combine( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
62+
const QString& shapefileName, bool onlySelectedFeatures = false,
63+
QProgressDialog* p = 0 );
64+
65+
/**Clip a vector layer based on the boundary of another vector layer and
66+
write output to a new shape file
67+
@param layerA input vector layer
68+
@param layerB input vector layer
69+
@param shapefileName path to the output shp
70+
@param onlySelectedFeatures if true, only selected features are considered, else all the features
71+
@param p progress dialog (or 0 if no progress dialog is to be shown)
72+
@note: added in version 1.4*/
73+
bool clip( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
74+
const QString& shapefileName, bool onlySelectedFeatures = false,
75+
QProgressDialog* p = 0 );
76+
77+
/**Difference a vector layer based on the geometries of another vector layer
78+
and write the output to a new shape file
79+
@param layerA input vector layer
80+
@param layerB input vector layer
81+
@param shapefileName path to the output shp
82+
@param onlySelectedFeatures if true, only selected features are considered, else all the features
83+
@param p progress dialog (or 0 if no progress dialog is to be shown)
84+
@note: added in version 1.4*/
85+
bool difference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
86+
const QString& shapefileName, bool onlySelectedFeatures = false,
87+
QProgressDialog* p = 0 );
88+
89+
/**Intersect two vector layers and write the geometries of each layer that
90+
do not intersect with the other layer to a new shape file (Symmetrical difference)
91+
@param layerA input vector layer
92+
@param layerB input vector layer
93+
@param shapefileName path to the output shp
94+
@param onlySelectedFeatures if true, only selected features are considered, else all the features
95+
@param p progress dialog (or 0 if no progress dialog is to be shown)
96+
@note: added in version 1.4*/
97+
bool symDifference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
98+
const QString& shapefileName, bool onlySelectedFeatures = false,
99+
QProgressDialog* p = 0 );
100+
#endif
99101

100102
private:
101103

‎src/core/composer/qgscomposerarrow.h

+4-3
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,15 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
6060
MarkerMode markerMode() const { return mMarkerMode;}
6161
void setMarkerMode( MarkerMode mode ) {mMarkerMode = mode;}
6262

63-
/** stores state in Dom node
64-
* @param node is Dom node corresponding to 'Composer' tag
65-
* @param temp write template file
63+
/** stores state in Dom element
64+
* @param elem is Dom element corresponding to 'Composer' tag
65+
* @param doc document
6666
*/
6767
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
6868

6969
/** sets state from Dom document
7070
* @param itemElem is Dom node corresponding to item tag
71+
* @param doc is the document to read
7172
*/
7273
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
7374

‎src/core/composer/qgscomposeritem.h

+10-3
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,15 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
6464
};
6565

6666
/**Constructor
67+
@param composition parent composition
6768
@param manageZValue true if the z-Value of this object should be managed by mComposition*/
6869
QgsComposerItem( QgsComposition* composition, bool manageZValue = true );
6970
/**Constructor with box position and composer object
71+
@param x x coordinate of item
72+
@param y y coordinate of item
73+
@param width width of item
74+
@param height height of item
75+
@param composition parent composition
7076
@param manageZValue true if the z-Value of this object should be managed by mComposition*/
7177
QgsComposerItem( qreal x, qreal y, qreal width, qreal height, QgsComposition* composition, bool manageZValue = true );
7278
virtual ~QgsComposerItem();
@@ -107,9 +113,9 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
107113
corresponds to 1 scene size unit*/
108114
virtual void setSceneRect( const QRectF& rectangle );
109115

110-
/** stores state in Dom node
111-
* @param node is Dom node corresponding to 'Composer' tag
112-
* @param temp write template file
116+
/** stores state in Dom element
117+
* @param elem is Dom element corresponding to 'Composer' tag
118+
* @param doc is the Dom document
113119
*/
114120
virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const = 0;
115121

@@ -118,6 +124,7 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
118124

119125
/** sets state from Dom document
120126
* @param itemElem is Dom node corresponding to item tag
127+
* @param doc is Dom document
121128
*/
122129
virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) = 0;
123130

‎src/core/composer/qgscomposeritemgroup.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,13 @@ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem
4242

4343
/** stores state in Dom node
4444
* @param elem is Dom element corresponding to 'Composer' tag
45-
* @param temp write template file
45+
* @param doc is the Dom document
4646
*/
4747
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
4848

4949
/** sets state from Dom document
5050
* @param itemElem is Dom node corresponding to item tag
51+
* @param doc is the Dom document
5152
*/
5253
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
5354

‎src/core/composer/qgscomposerlabel.h

+5-4
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,15 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
5757
@note: this function was added in version 1.4*/
5858
QColor fontColor() const {return mFontColor;}
5959

60-
/** stores state in Dom node
61-
* @param node is Dom node corresponding to 'Composer' tag
62-
* @param temp write template file
60+
/** stores state in Dom element
61+
* @param elem is Dom element corresponding to 'Composer' tag
62+
* @param doc document
6363
*/
6464
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
6565

6666
/** sets state from Dom document
67-
* @param node is Dom node corresponding to 'ComposerLabel' tag
67+
* @param itemElem is Dom element corresponding to 'ComposerLabel' tag
68+
* @param doc document
6869
*/
6970
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
7071

‎src/core/composer/qgscomposerlegend.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,13 @@ class CORE_EXPORT QgsComposerLegend: public QgsComposerItem
8888

8989
/** stores state in Dom node
9090
* @param elem is Dom element corresponding to 'Composer' tag
91-
* @param temp write template file
91+
* @param doc Dom document
9292
*/
9393
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
9494

9595
/** sets state from Dom document
9696
* @param itemElem is Dom node corresponding to item tag
97+
* @param doc is Dom document
9798
*/
9899
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
99100

@@ -135,6 +136,7 @@ class CORE_EXPORT QgsComposerLegend: public QgsComposerItem
135136
void drawLayerItem( QPainter* p, QgsComposerLayerItem* layerItem, double& currentYCoord, double& maxXCoord );
136137

137138
/**Draws child items of a layer item
139+
@param p painter
138140
@param layerItem parent model item (layer)
139141
@param currentYCoord in/out: current y position of legend item
140142
@param maxXCoord in/out: maximum x-coordinate of the whole legend

‎src/core/composer/qgscomposermap.h

+7-3
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
7878
void draw( QPainter *painter, const QgsRectangle& extent, const QSize& size, int dpi );
7979

8080
/** \brief Draw to paint device
81+
@param painter painter
8182
@param extent map extent
8283
@param size size in scene coordinates
8384
@param dpi scene dpi*/
@@ -155,12 +156,13 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
155156

156157
/** stores state in Dom node
157158
* @param elem is Dom element corresponding to 'Composer' tag
158-
* @param temp write template file
159+
* @param doc Dom document
159160
*/
160161
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
161162

162163
/** sets state from Dom document
163164
* @param itemElem is Dom node corresponding to 'ComposerMap' tag
165+
* @param doc is Dom document
164166
*/
165167
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
166168

@@ -353,14 +355,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
353355
/**Draws the map grid*/
354356
void drawGrid( QPainter* p );
355357
/**Draw coordinates for mGridAnnotationType Coordinate
356-
@param lines the coordinate lines in item coordinates*/
358+
@param p drawing painter
359+
@param hLines horizontal coordinate lines in item coordinates
360+
@param vLines vertical coordinate lines in item coordinates*/
357361
void drawCoordinateAnnotations( QPainter* p, const QList< QPair< double, QLineF > >& hLines, const QList< QPair< double, QLineF > >& vLines );
358362
void drawCoordinateAnnotation( QPainter* p, const QPointF& pos, QString annotationString );
359363
/**Draws a single annotation
360364
@param p drawing painter
361365
@param pos item coordinates where to draw
362366
@param rotation text rotation
363-
@param the text to draw*/
367+
@param annotationText the text to draw*/
364368
void drawAnnotation( QPainter* p, const QPointF& pos, int rotation, const QString& annotationText );
365369
/**Returns the grid lines with associated coordinate value
366370
@return 0 in case of success*/

‎src/core/composer/qgscomposerpicture.h

+5-6
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,15 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
4242
corresponds to 1 scene size unit and resizes the svg symbol / image*/
4343
void setSceneRect( const QRectF& rectangle );
4444

45-
/** stores state in Dom node
46-
* @param node is Dom node corresponding to 'Composer' tag
47-
* @param temp write template file
45+
/** stores state in Dom element
46+
* @param elem is Dom element corresponding to 'Composer' tag
47+
* @param doc is Dom document
4848
*/
4949
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
5050

5151
/** sets state from Dom document
5252
* @param itemElem is Dom node corresponding to item tag
53+
* @param doc is Dom document
5354
*/
5455
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
5556

@@ -80,9 +81,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
8081
/**Calculates bounding rect for image such that aspect ratio is correct*/
8182
QRectF boundedImageRect( double deviceWidth, double deviceHeight );
8283

83-
/**Updates content of mImage using svg generator
84-
@param out: boundWidth width of mImage that is used by the svg renderer. May different from mImage.width() to preserve aspect ratio
85-
@param out: boundHeight height of mImage that is used by the svg renderer*/
84+
/**Updates content of mImage using svg generator*/
8685
void updateImageFromSvg();
8786

8887

0 commit comments

Comments
 (0)