Skip to content

Commit 3bb9496

Browse files
committed
composer api doxygen fixes
1 parent 7a0c6d5 commit 3bb9496

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

src/core/composer/qgscomposeritem.h

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -159,33 +159,30 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
159159
bool _readXML( const QDomElement& itemElem, const QDomDocument& doc );
160160

161161
/** Whether this item has a frame or not.
162-
* @param none
163162
* @return boolean - true if there is a frame around this item, otherwise false.
164163
* @note deprecated since 1.8 dont use!
165164
* @see hasFrame
166165
*/
167-
bool frame() const {return hasFrame();}
166+
Q_DECL_DEPRECATED bool frame() const {return hasFrame();}
168167
/** Whether this item has a frame or not.
169-
* @param none
170-
* @return boolean - true if there is a frame around this item, otherwise false.
168+
* @returns true if there is a frame around this item, otherwise false.
171169
* @note introduced since 1.8
172170
* @see hasFrame
173171
*/
174172
bool hasFrame() const {return mFrame;}
175173
/** Set whether this item has a frame drawn around it or not.
176-
* @param none
177-
* @return void
174+
* @returns void
178175
* @note deprecated since 1.8 dont use!
179176
* @see hasFrame
180177
*/
181-
void setFrame( bool drawFrame ) { setFrameEnabled( drawFrame );}
178+
Q_DECL_DEPRECATED void setFrame( bool drawFrame ) { setFrameEnabled( drawFrame );}
182179
/** Set whether this item has a frame drawn around it or not.
183-
* @param none
184-
* @return void
180+
* @param drawFrame draw frame
181+
* @returns nothing
185182
* @note deprecated since 1.8
186183
* @see hasFrame
187184
*/
188-
void setFrameEnabled( bool drawFrame ) {mFrame = drawFrame;}
185+
Q_DECL_DEPRECATED void setFrameEnabled( bool drawFrame ) {mFrame = drawFrame;}
189186

190187
/**Composite operations for item groups do nothing per default*/
191188
virtual void addItem( QgsComposerItem* item ) { Q_UNUSED( item ); }

src/core/composer/qgscomposerlabel.h

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,20 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
4747
QFont font() const;
4848
void setFont( const QFont& f );
4949
/** Accessor for the vertical alignment of the label
50-
* @param none
5150
* @returns Qt::AlignmentFlag
5251
*/
5352
Qt::AlignmentFlag vAlign() const { return mVAlignment; }
5453
/** Accessor for the horizontal alignment of the label
55-
* @param none
5654
* @returns Qt::AlignmentFlag
5755
*/
5856
Qt::AlignmentFlag hAlign() const { return mHAlignment; }
5957
/** Mutator for the horizontal alignment of the label
60-
* @param Qt::AlignmentFlag
58+
* @param a alignment
6159
* @returns void
6260
*/
6361
void setHAlign( Qt::AlignmentFlag a ) {mHAlignment = a;}
6462
/** Mutator for the vertical alignment of the label
65-
* @param QQt::AlignmentFlag
63+
* @param a alignment
6664
* @returns void
6765
*/
6866
void setVAlign( Qt::AlignmentFlag a ) {mVAlignment = a;}

0 commit comments

Comments
 (0)