doxygen fixes

git-svn-id: http://svn.osgeo.org/qgis/trunk@14319 c8812cc2-4d05-0410-92ff-de0c093fc19c

doc/modules.dox

@@ -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.
 */
 

src/analysis/interpolation/DualEdgeTriangulation.h

@@ -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 );

src/analysis/interpolation/Triangulation.h

@@ -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;

src/analysis/interpolation/qgstininterpolator.h

@@ -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

src/analysis/vector/qgsgeometryanalyzer.h

@@ -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)

src/analysis/vector/qgsoverlayanalyzer.h

@@ -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:
 

src/core/composer/qgscomposerarrow.h

@@ -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 );
 

src/core/composer/qgscomposeritem.h

@@ -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;
 

src/core/composer/qgscomposeritemgroup.h

@@ -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 );
 

src/core/composer/qgscomposerlabel.h

@@ -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 );
 

src/core/composer/qgscomposerlegend.h

@@ -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

src/core/composer/qgscomposermap.h

@@ -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*/

src/core/composer/qgscomposerpicture.h

@@ -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();