From 3bb9496c99c2415c03c18c2f84d5c96b0a157693 Mon Sep 17 00:00:00 2001 From: "Juergen E. Fischer" Date: Wed, 7 Mar 2012 07:50:18 +0100 Subject: [PATCH] composer api doxygen fixes --- src/core/composer/qgscomposeritem.h | 17 +++++++---------- src/core/composer/qgscomposerlabel.h | 6 ++---- 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/src/core/composer/qgscomposeritem.h b/src/core/composer/qgscomposeritem.h index 9f03760fa6ea..015ad96b1706 100644 --- a/src/core/composer/qgscomposeritem.h +++ b/src/core/composer/qgscomposeritem.h @@ -159,33 +159,30 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem bool _readXML( const QDomElement& itemElem, const QDomDocument& doc ); /** Whether this item has a frame or not. - * @param none * @return boolean - true if there is a frame around this item, otherwise false. * @note deprecated since 1.8 dont use! * @see hasFrame */ - bool frame() const {return hasFrame();} + Q_DECL_DEPRECATED bool frame() const {return hasFrame();} /** Whether this item has a frame or not. - * @param none - * @return boolean - true if there is a frame around this item, otherwise false. + * @returns true if there is a frame around this item, otherwise false. * @note introduced since 1.8 * @see hasFrame */ bool hasFrame() const {return mFrame;} /** Set whether this item has a frame drawn around it or not. - * @param none - * @return void + * @returns void * @note deprecated since 1.8 dont use! * @see hasFrame */ - void setFrame( bool drawFrame ) { setFrameEnabled( drawFrame );} + Q_DECL_DEPRECATED void setFrame( bool drawFrame ) { setFrameEnabled( drawFrame );} /** Set whether this item has a frame drawn around it or not. - * @param none - * @return void + * @param drawFrame draw frame + * @returns nothing * @note deprecated since 1.8 * @see hasFrame */ - void setFrameEnabled( bool drawFrame ) {mFrame = drawFrame;} + Q_DECL_DEPRECATED void setFrameEnabled( bool drawFrame ) {mFrame = drawFrame;} /**Composite operations for item groups do nothing per default*/ virtual void addItem( QgsComposerItem* item ) { Q_UNUSED( item ); } diff --git a/src/core/composer/qgscomposerlabel.h b/src/core/composer/qgscomposerlabel.h index 2978633f9387..fe1b0b65a621 100644 --- a/src/core/composer/qgscomposerlabel.h +++ b/src/core/composer/qgscomposerlabel.h @@ -47,22 +47,20 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem QFont font() const; void setFont( const QFont& f ); /** Accessor for the vertical alignment of the label - * @param none * @returns Qt::AlignmentFlag */ Qt::AlignmentFlag vAlign() const { return mVAlignment; } /** Accessor for the horizontal alignment of the label - * @param none * @returns Qt::AlignmentFlag */ Qt::AlignmentFlag hAlign() const { return mHAlignment; } /** Mutator for the horizontal alignment of the label - * @param Qt::AlignmentFlag + * @param a alignment * @returns void */ void setHAlign( Qt::AlignmentFlag a ) {mHAlignment = a;} /** Mutator for the vertical alignment of the label - * @param QQt::AlignmentFlag + * @param a alignment * @returns void */ void setVAlign( Qt::AlignmentFlag a ) {mVAlignment = a;}