Skip to content

Commit 6b25fe5

Browse files
committedJul 23, 2015
Doxymentation
1 parent de547ad commit 6b25fe5

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed
 

‎src/core/symbology-ng/qgssymbolv2.h

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,16 +112,32 @@ class CORE_EXPORT QgsSymbolV2
112112
*/
113113
int symbolLayerCount() { return mLayers.count(); }
114114

115-
//! insert symbol layer to specified index
115+
/**
116+
* Insert symbol layer to specified index
117+
* Ownership will be transferred.
118+
* @param index The index at which the layer should be added
119+
* @param layer The symbol layer to add
120+
* @return True if the layer is added, False if the index or the layer is bad
121+
*/
116122
bool insertSymbolLayer( int index, QgsSymbolLayerV2* layer );
117123

118-
//! append symbol layer at the end of the list
124+
/**
125+
* Append symbol layer at the end of the list
126+
* Ownership will be transferred.
127+
* @param layer The layer to add
128+
* @return True if the layer is added, False if the layer is bad
129+
*/
119130
bool appendSymbolLayer( QgsSymbolLayerV2* layer );
120131

121132
//! delete symbol layer at specified index
122133
bool deleteSymbolLayer( int index );
123134

124-
//! remove symbol layer from the list and return pointer to it
135+
/**
136+
* Remove symbol layer from the list and return pointer to it.
137+
* Ownership is handed to the caller.
138+
* @param index The index of the layer to remove
139+
* @return A pointer to the removed layer
140+
*/
125141
QgsSymbolLayerV2* takeSymbolLayer( int index );
126142

127143
//! delete layer at specified index and set a new one

‎src/gui/editorwidgets/core/qgswidgetwrapper.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject
127127
* another suitable widget type instead.
128128
*
129129
* @return Validity status of this widget.
130+
*
131+
* @note Added in 2.12
130132
*/
131133
virtual bool valid() = 0;
132134

0 commit comments

Comments
 (0)
Please sign in to comment.