Skip to content
Permalink
Browse files

fix doxygen warnings

  • Loading branch information
jef-n committed Sep 21, 2014
1 parent febe37d commit 96e47ed51616ba21f5092e09069201df4cf06736
@@ -59,13 +59,15 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
/**Writes properties specific to attribute tables
* @param elem an existing QDomElement in which to store the attribute table's properties.
* @param doc QDomDocument for the destination xml.
* @param ignoreFrames ignore frames
* @see readXML
*/
virtual bool writeXML( QDomElement& elem, QDomDocument & doc, bool ignoreFrames = false ) const;

/**Reads the properties specific to an attribute table from xml.
* @param itemElem a QDomElement holding the attribute table's desired properties.
* @param doc QDomDocument for the source xml.
* @param ignoreFrames ignore frames
* @see writeXML
*/
virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc, bool ignoreFrames = false );
@@ -192,7 +194,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
QList<QPair<int, bool> > sortAttributes() const;

/**Queries the attribute table's vector layer for attributes to show in the table.
* @param attributeMaps list of QgsAttributeMaps where the fetched feature attributes will be stored
* @param content table content
* @returns true if attributes were successfully fetched
* @note not available in python bindings
*/
@@ -187,7 +187,7 @@ class CORE_EXPORT QgsComposerMapItemStack
void addItem( QgsComposerMapItem* item );

/**Removes an item from the stack and deletes the corresponding QgsComposerMapItem
* @param QgsComposerMapItem id for the QgsComposerMapItem to remove
* @param itemId id for the QgsComposerMapItem to remove
* @note after removing an item from the stack, update()
* should be called for the QgsComposerMap to prevent rendering artifacts
* @see addItem
@@ -203,7 +203,7 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
QPainter::CompositionMode blendMode() const { return mBlendMode; }

/**Sets the blending mode used for drawing the overview.
* @param mode blending mode for overview
* @param blendMode blending mode for overview
* @see blendMode
*/
void setBlendMode( const QPainter::CompositionMode blendMode );
@@ -126,7 +126,6 @@ class GUI_EXPORT QgsIdentifyMenu : public QMenu
* @brief exec
* @param idResults the list of identify results to choose within
* @param pos the position where the menu will be executed
* @param selectedAction if specified, this will allow to know which action has been triggered
*/
QList<QgsMapToolIdentify::IdentifyResult> exec( const QList<QgsMapToolIdentify::IdentifyResult> idResults, QPoint pos );

@@ -110,7 +110,6 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
@param y y coordinates of mouseEvent
@param layerList Performs the identification within the given list of layers. Default value is an empty list, i.e. uses all the layers.
@param mode Identification mode. Can use Qgis default settings or a defined mode. Default mode is DefaultQgsSetting.
@param selectedAction will set the pointer of the action clicked in the menu (if corresponding mode is used). This is useful for custom actions.
@return a list of IdentifyResult*/
QList<IdentifyResult> identify( int x, int y, QList<QgsMapLayer*> layerList = QList<QgsMapLayer*>(), IdentifyMode mode = DefaultQgsSetting );

@@ -121,7 +120,6 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
@param y y coordinates of mouseEvent
@param mode Identification mode. Can use Qgis default settings or a defined mode.
@param layerType Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers.
@param selectedAction will set the pointer of the action clicked in the menu (if corresponding mode is used). This is useful for custom actions.
@return a list of IdentifyResult*/
QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, LayerType layerType = AllLayers );

@@ -146,7 +144,6 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
@param mode Identification mode. Can use Qgis default settings or a defined mode.
@param layerList Performs the identification within the given list of layers.
@param layerType Only performs identification in a certain type of layers (raster, vector).
@param selectedAction will set the pointer of the action clicked in the menu (if corresponding mode is used). This is useful for custom actions.
@return a list of IdentifyResult*/
QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, QList<QgsMapLayer*> layerList, LayerType layerType = AllLayers );

0 comments on commit 96e47ed

Please sign in to comment.
You can’t perform that action at this time.