From 6b25fe53059e604fa3f8fce25f8a8ff271d7c8ed Mon Sep 17 00:00:00 2001 From: Matthias Kuhn Date: Thu, 23 Jul 2015 12:40:43 +0200 Subject: [PATCH] Doxymentation --- src/core/symbology-ng/qgssymbolv2.h | 22 ++++++++++++++++--- src/gui/editorwidgets/core/qgswidgetwrapper.h | 2 ++ 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/src/core/symbology-ng/qgssymbolv2.h b/src/core/symbology-ng/qgssymbolv2.h index 141c94f5bdd..3027fd7ce67 100644 --- a/src/core/symbology-ng/qgssymbolv2.h +++ b/src/core/symbology-ng/qgssymbolv2.h @@ -112,16 +112,32 @@ class CORE_EXPORT QgsSymbolV2 */ int symbolLayerCount() { return mLayers.count(); } - //! insert symbol layer to specified index + /** + * Insert symbol layer to specified index + * Ownership will be transferred. + * @param index The index at which the layer should be added + * @param layer The symbol layer to add + * @return True if the layer is added, False if the index or the layer is bad + */ bool insertSymbolLayer( int index, QgsSymbolLayerV2* layer ); - //! append symbol layer at the end of the list + /** + * Append symbol layer at the end of the list + * Ownership will be transferred. + * @param layer The layer to add + * @return True if the layer is added, False if the layer is bad + */ bool appendSymbolLayer( QgsSymbolLayerV2* layer ); //! delete symbol layer at specified index bool deleteSymbolLayer( int index ); - //! remove symbol layer from the list and return pointer to it + /** + * Remove symbol layer from the list and return pointer to it. + * Ownership is handed to the caller. + * @param index The index of the layer to remove + * @return A pointer to the removed layer + */ QgsSymbolLayerV2* takeSymbolLayer( int index ); //! delete layer at specified index and set a new one diff --git a/src/gui/editorwidgets/core/qgswidgetwrapper.h b/src/gui/editorwidgets/core/qgswidgetwrapper.h index 8d8b536c6fe..31d10e266b0 100644 --- a/src/gui/editorwidgets/core/qgswidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgswidgetwrapper.h @@ -127,6 +127,8 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * another suitable widget type instead. * * @return Validity status of this widget. + * + * @note Added in 2.12 */ virtual bool valid() = 0;