Skip to content
Permalink
Browse files
doxygen fixes
git-svn-id: http://svn.osgeo.org/qgis/trunk@14319 c8812cc2-4d05-0410-92ff-de0c093fc19c
  • Loading branch information
jef committed Sep 30, 2010
1 parent 1c42e9a commit f19c7aac24a9db4908d5e7b2dc1111a9b7f6a781
Showing with 1,290 additions and 833 deletions.
  1. +948 −558 Doxyfile
  2. +7 −6 doc/modules.dox
  3. +1 −2 src/analysis/interpolation/DualEdgeTriangulation.h
  4. +1 −2 src/analysis/interpolation/Triangulation.h
  5. +2 −2 src/analysis/interpolation/qgstininterpolator.h
  6. +0 −6 src/analysis/vector/qgsgeometryanalyzer.h
  7. +48 −46 src/analysis/vector/qgsoverlayanalyzer.h
  8. +4 −3 src/core/composer/qgscomposerarrow.h
  9. +10 −3 src/core/composer/qgscomposeritem.h
  10. +2 −1 src/core/composer/qgscomposeritemgroup.h
  11. +5 −4 src/core/composer/qgscomposerlabel.h
  12. +3 −1 src/core/composer/qgscomposerlegend.h
  13. +7 −3 src/core/composer/qgscomposermap.h
  14. +5 −6 src/core/composer/qgscomposerpicture.h
  15. +3 −2 src/core/composer/qgscomposerscalebar.h
  16. +4 −3 src/core/composer/qgscomposershape.h
  17. +4 −3 src/core/composer/qgspaperitem.h
  18. +1 −0 src/core/composer/qgsscalebarstyle.h
  19. +4 −0 src/core/composer/qgssingleboxscalebarstyle.h
  20. +4 −0 src/core/composer/qgsticksscalebarstyle.h
  21. +1 −1 src/core/qgsapplication.h
  22. +23 −21 src/core/qgscoordinatereferencesystem.h
  23. +8 −6 src/core/qgscoordinatetransform.h
  24. +1 −1 src/core/qgsdataprovider.h
  25. +1 −1 src/core/qgsfield.h
  26. +7 −6 src/core/qgsgeometry.h
  27. +1 −1 src/core/qgshttptransaction.h
  28. +17 −5 src/core/qgslabel.h
  29. +18 −16 src/core/qgsmaplayer.h
  30. +1 −1 src/core/qgsnetworkaccessmanager.cpp
  31. +1 −1 src/core/qgspallabeling.h
  32. +24 −25 src/core/qgsproject.cpp
  33. +1 −1 src/core/qgsproject.h
  34. +1 −1 src/core/qgsprojectproperty.cpp
  35. +5 −3 src/core/qgsprojectproperty.h
  36. +2 −2 src/core/qgsrasterdataprovider.h
  37. +3 −1 src/core/qgstolerance.h
  38. +1 −1 src/core/qgsvectordataprovider.h
  39. +1 −1 src/core/qgsvectorfilewriter.h
  40. +9 −7 src/core/qgsvectorlayer.h
  41. +41 −34 src/core/raster/qgsrasterlayer.cpp
  42. +1 −1 src/core/raster/qgsrasterlayer.h
  43. +5 −3 src/core/renderer/qgsgraduatedsymbolrenderer.h
  44. +6 −3 src/core/renderer/qgsrenderer.h
  45. +1 −0 src/core/symbology-ng/qgscategorizedsymbolrendererv2.h
  46. +8 −0 src/core/symbology/qgsmarkercatalogue.h
  47. +1 −0 src/gui/qgisgui.h
  48. +2 −2 src/gui/qgisinterface.h
  49. +1 −0 src/gui/qgsattributeeditor.h
  50. +2 −2 src/gui/qgsgenericprojectionselector.cpp
  51. +1 −1 src/gui/qgsmapcanvas.cpp
  52. +1 −1 src/gui/qgsmapcanvassnapper.h
  53. +5 −6 src/gui/qgsmaptip.h
  54. +9 −9 src/gui/qgsprojectbadlayerguihandler.h
  55. +1 −1 src/gui/qgsprojectionselector.h
  56. +4 −4 src/gui/qgsquickprint.h
  57. +2 −3 src/gui/qgsrubberband.h
  58. +1 −1 src/mapserver/qgsconfigcache.h
  59. +1 −1 src/mapserver/qgssldrule.h
  60. +6 −6 src/mapserver/qgswmsserver.h
  61. +1 −1 src/plugins/qgisplugin.h
  62. +1 −1 src/plugins/qgsapplydialog.h
1,506 Doxyfile

Large diffs are not rendered by default.

@@ -1,17 +1,18 @@
/** @defgroup core
/** @defgroup core QGIS core library

QGIS core library. Contains all basic GIS functionality.
Contains all basic GIS functionality.

*/

/** @defgroup gui
/** @defgroup gui QGIS gui library.

It's built on top of core library and adds reusable GUI widgets.

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

/** @defgroup analysis
/** @defgroup analysis QGIS analysis library.

Analysis library. Built on top of core library, the analysis library provides
Built on top of core library, the analysis library provides
high level tools for carrying out spatial analysis on vector and raster data.
*/

@@ -92,8 +92,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
void setTriangleInterpolator( TriangleInterpolator* interpolator );
/**Eliminates the horizontal triangles by swapping or by insertion of new points*/
void eliminateHorizontalTriangles();
/**Adds points to make the triangles better shaped (algorithm of ruppert)
\param tin the triangulation or decorator which interpolates the elevation*/
/**Adds points to make the triangles better shaped (algorithm of ruppert)*/
virtual void ruppertRefinement();
/**Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/
bool pointInside( double x, double y );
@@ -77,8 +77,7 @@ class ANALYSIS_EXPORT Triangulation
virtual void setTriangleInterpolator( TriangleInterpolator* interpolator ) = 0;
/**Eliminates the horizontal triangles by swapping*/
virtual void eliminateHorizontalTriangles() = 0;
/**Adds points to make the triangles better shaped (algorithm of ruppert)
\param tin the triangulation or decorator which interpolates the elevation*/
/**Adds points to make the triangles better shaped (algorithm of ruppert)*/
virtual void ruppertRefinement() = 0;
/**Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/
virtual bool pointInside( double x, double y ) = 0;
@@ -62,8 +62,8 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator

/**Create dual edge triangulation*/
void initialize();
/**Inserts the vertices of a geometry into the triangulation
@param g the geometry
/**Inserts the vertices of a feature into the triangulation
@param f the feature
@param zCoord true if the z coordinate is the interpolation attribute
@param attr interpolation attribute index (if zCoord is false)
@param type point/structure line, break line
@@ -42,7 +42,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param tolerance (level of simplification)
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@@ -54,7 +53,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
@@ -64,7 +62,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Create a polygon based on the extent of all (selected) features and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
@@ -73,7 +70,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Create buffers for a vector layer and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param bufferDistance distance for buffering (if no buffer field is specified)
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param dissolve if true, merge all the buffers to a big multipolygon
@@ -86,7 +82,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Create convex hull(s) of a vector layer and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param uniqueIdField index of the attribute field that contains the unique convex hull id (or -1 if
all features have the same buffer distance)
@@ -98,7 +93,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Dissolve a vector layer and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param uniqueIdField index of the attribute field that contains the unique id to dissolve on (or -1 if
all features should be dissolved together)
@@ -50,52 +50,54 @@ class ANALYSIS_EXPORT QgsOverlayAnalyzer
const QString& shapefileName, bool onlySelectedFeatures = false, \
QProgressDialog* p = 0 );

// /**Perform a union of two input vector layers and write output to a new shape file
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool combine( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
//
// /**Clip a vector layer based on the boundary of another vector layer and
// write output to a new shape file
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool clip( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
//
// /**Difference a vector layer based on the geometries of another vector layer
// and write the output to a new shape file
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool difference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
//
// /**Intersect two vector layers and write the geometries of each layer that
// do not intersect with the other layer to a new shape file (Symmetrical difference)
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool symDifference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
#if 0
/**Perform a union of two input vector layers and write output to a new shape file
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool combine( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );

/**Clip a vector layer based on the boundary of another vector layer and
write output to a new shape file
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool clip( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );

/**Difference a vector layer based on the geometries of another vector layer
and write the output to a new shape file
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool difference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );

/**Intersect two vector layers and write the geometries of each layer that
do not intersect with the other layer to a new shape file (Symmetrical difference)
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool symDifference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );
#endif

private:

@@ -60,14 +60,15 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
MarkerMode markerMode() const { return mMarkerMode;}
void setMarkerMode( MarkerMode mode ) {mMarkerMode = mode;}

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

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

@@ -64,9 +64,15 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
};

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

/** stores state in Dom node
* @param node is Dom node corresponding to 'Composer' tag
* @param temp write template file
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param doc is the Dom document
*/
virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const = 0;

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

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

@@ -42,12 +42,13 @@ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem

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

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

@@ -57,14 +57,15 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
@note: this function was added in version 1.4*/
QColor fontColor() const {return mFontColor;}

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

/** sets state from Dom document
* @param node is Dom node corresponding to 'ComposerLabel' tag
* @param itemElem is Dom element corresponding to 'ComposerLabel' tag
* @param doc document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

@@ -88,12 +88,13 @@ class CORE_EXPORT QgsComposerLegend: public QgsComposerItem

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

/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

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

/**Draws child items of a layer item
@param p painter
@param layerItem parent model item (layer)
@param currentYCoord in/out: current y position of legend item
@param maxXCoord in/out: maximum x-coordinate of the whole legend
@@ -78,6 +78,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
void draw( QPainter *painter, const QgsRectangle& extent, const QSize& size, int dpi );

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

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

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

@@ -353,14 +355,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/**Draws the map grid*/
void drawGrid( QPainter* p );
/**Draw coordinates for mGridAnnotationType Coordinate
@param lines the coordinate lines in item coordinates*/
@param p drawing painter
@param hLines horizontal coordinate lines in item coordinates
@param vLines vertical coordinate lines in item coordinates*/
void drawCoordinateAnnotations( QPainter* p, const QList< QPair< double, QLineF > >& hLines, const QList< QPair< double, QLineF > >& vLines );
void drawCoordinateAnnotation( QPainter* p, const QPointF& pos, QString annotationString );
/**Draws a single annotation
@param p drawing painter
@param pos item coordinates where to draw
@param rotation text rotation
@param the text to draw*/
@param annotationText the text to draw*/
void drawAnnotation( QPainter* p, const QPointF& pos, int rotation, const QString& annotationText );
/**Returns the grid lines with associated coordinate value
@return 0 in case of success*/
@@ -42,14 +42,15 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
corresponds to 1 scene size unit and resizes the svg symbol / image*/
void setSceneRect( const QRectF& rectangle );

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

/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

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

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


0 comments on commit f19c7aa

Please sign in to comment.