Skip to content
Permalink
Browse files

doxygen fixes

  • Loading branch information
jef-n committed Aug 9, 2014
1 parent a6a6177 commit a2a66eabfdcec39b2c70723e2033c60a36774302
@@ -93,7 +93,8 @@ class QgsComposition : QGraphicsScene
void setStatusMessage( const QString & message );

/**Refreshes the composition when composer related options change
*Note: added in version 2.1*/
@note added in version 2.1
*/
void updateSettings();

void setSnapToGridEnabled( const bool b );
@@ -109,7 +110,7 @@ class QgsComposition : QGraphicsScene
void setAlignmentSnap( const bool s );
bool alignmentSnap() const;

void setSmartGuidesEnabled( bool b );
void setSmartGuidesEnabled( const bool b );
bool smartGuidesEnabled() const;

/**Removes all snap lines*/
@@ -164,11 +165,11 @@ class QgsComposition : QGraphicsScene

/**Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides
* and the edges and centers of other items.
* @param t snap tolerance in pixels
* @param snapTolerance snap tolerance in pixels
* @see alignmentSnapTolerance
* @note Added in QGIS 2.5
*/
void setSnapTolerance( int snapTolerance );
void setSnapTolerance( const int snapTolerance );

/**Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides
* and the edges and centers of other items.
@@ -300,6 +301,11 @@ class QgsComposition : QGraphicsScene
/**Add items from XML representation to the graphics scene (for project file reading, pasting items from clipboard)
@param elem items parent element, e.g. \verbatim <Composer> \endverbatim or \verbatim <ComposerItemClipboard> \endverbatim
@param doc xml document
@param mapsToRestore for reading from project file: set preview move 'rectangle' to all maps and save the preview states to show composer maps on demand
@param addUndoCommands insert AddItem commands if true (e.g. for copy/paste)
@param pos item position. Optional, take position from xml if 0
@param pasteInPlace whether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor)
@note parameters mapsToResotre, addUndoCommands pos and pasteInPlace not available in python bindings
*/
void addItemsFromXML( const QDomElement& elem, const QDomDocument& doc );

@@ -308,6 +314,9 @@ class QgsComposition : QGraphicsScene
/**Removes item from z list. Usually called from destructor of QgsComposerItem*/
void removeItemFromZList( QgsComposerItem* item );

//functions to move selected items in hierarchy
void raiseSelectedItems();

//returns true if successful
bool raiseItem( QgsComposerItem* item );
void lowerSelectedItems();
@@ -321,7 +330,7 @@ class QgsComposition : QGraphicsScene
bool moveItemToBottom( QgsComposerItem* item );

//functions to find items by their position in the z list
void selectNextByZOrder( ZValueDirection direction );
void selectNextByZOrder( const ZValueDirection direction );
QgsComposerItem* getComposerItemBelow( QgsComposerItem* item ) const;
QgsComposerItem* getComposerItemAbove( QgsComposerItem* item ) const;

@@ -341,7 +350,7 @@ class QgsComposition : QGraphicsScene

/**Sorts the zList. The only time where this function needs to be called is from QgsComposer
* after reading all the items from xml file
* @note deprecated, see @refreshZList instead
* @deprecated use refreshZList instead
*/
void sortZList() /Deprecated/;

@@ -428,8 +437,8 @@ class QgsComposition : QGraphicsScene

/**Print on a preconfigured printer
* @param printer QPrinter destination
* @painter QPainter source
* @startNewPage set to true to begin the print on a new page
* @param painter QPainter source
* @param startNewPage set to true to begin the print on a new page
*/
void doPrint( QPrinter& printer, QPainter& painter, bool startNewPage = false );

@@ -460,7 +469,7 @@ class QgsComposition : QGraphicsScene
* @deprecated use QgsComposerUtils::relativeResizeRect instead
*/
static void relativeResizeRect( QRectF& rectToResize, const QRectF& boundsBefore, const QRectF& boundsAfter ) /Deprecated/;

/**Returns a scaled position given a before and after range
* @deprecated use QgsComposerUtils::relativePosition instead
*/
@@ -495,17 +504,17 @@ class QgsComposition : QGraphicsScene
* @param active true if data defined property is active, false if it is disabled
* @param useExpression true if the expression should be used
* @param expression expression for data defined property
* @field field name if the data defined property should take its value from a field
* @param field name if the data defined property should take its value from a field
* @note this method was added in version 2.5
*/
void setDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property, bool active, bool useExpression, const QString &expression, const QString &field );

/**Returns the items model attached to the composition
/**Returns the items model attached to the composition
* @returns QgsComposerModel for composition
* @note this method was added in version 2.5
*/
QgsComposerModel * itemsModel();

public slots:
/**Casts object to the proper subclass type and calls corresponding itemAdded signal*/
void sendItemAddedSignal( QgsComposerItem* item );
@@ -482,7 +482,7 @@ class QgisInterface : QObject
/** @note added in 1.9 */
virtual QAction *actionCancelAllEdits() = 0;
virtual QAction *actionLayerSaveAs() = 0;
/** @note deprecated in 2.4 - returns null pointer */
/** @deprecated in 2.4 - returns null pointer */
virtual QAction *actionLayerSelectionSaveAs() = 0 /Deprecated/;
virtual QAction *actionRemoveLayer() = 0;
/** @note added in 1.9 */
@@ -123,7 +123,6 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
Q_DECL_DEPRECATED void setArrowColor( const QColor& c );

/**Sets the color used to draw the outline around the arrow head.
* @param color arrow head outline color
* @see setArrowHeadFillColor
* @see arrowHeadFillColor
* @note added in 2.5
@@ -139,7 +138,6 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
void setArrowHeadOutlineColor( const QColor& color );

/**Sets the color used to draw the arrow head.
* @param color arrow head color
* @see setArrowHeadFillColor
* @see arrowHeadOutlineColor
* @note added in 2.5
@@ -153,7 +153,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene
void setStatusMessage( const QString & message );

/**Refreshes the composition when composer related options change
*Note: added in version 2.1*/
@note added in version 2.1
*/
void updateSettings();

void setSnapToGridEnabled( const bool b );
@@ -362,7 +363,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene
@param addUndoCommands insert AddItem commands if true (e.g. for copy/paste)
@param pos item position. Optional, take position from xml if 0
@param pasteInPlace whether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor)
@note not available in python bindings
@note parameters mapsToResotre, addUndoCommands pos and pasteInPlace not available in python bindings
*/
void addItemsFromXML( const QDomElement& elem, const QDomDocument& doc, QMap< QgsComposerMap*, int >* mapsToRestore = 0,
bool addUndoCommands = false, QPointF* pos = 0, bool pasteInPlace = false );
@@ -408,7 +409,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene

/**Sorts the zList. The only time where this function needs to be called is from QgsComposer
* after reading all the items from xml file
* @note deprecated, see @refreshZList instead
* @deprecated use refreshZList instead
*/
Q_DECL_DEPRECATED void sortZList() {};

@@ -230,7 +230,7 @@ namespace pal
FeatCallBackCtx *context = ( FeatCallBackCtx* ) ctx;

#ifdef _EXPORT_MAP_
bool svged = false; // is the feature has been written into the svg map ?
bool svged = false; // is the feature has been written into the svg map?
int dpi = context->layer->pal->getDpi();
#endif

@@ -248,15 +248,15 @@ namespace pal

// first do some checks whether to extract candidates or not

// feature has to be labeled ?
// feature has to be labeled?
if ( !context->layer->toLabel )
return true;

// are we in a valid scale range for the layer?
if ( !context->layer->isScaleValid( context->scale ) )
return true;

// is the feature well defined ? TODO Check epsilon
// is the feature well defined? TODO Check epsilon
if ( ft_ptr->getLabelWidth() < 0.0000001 || ft_ptr->getLabelHeight() < 0.0000001 )
return true;

@@ -729,7 +729,7 @@ namespace pal
t.start();

// First, extract the problem
// TODO which is the minimum scale ? (> 0, >= 0, >= 1, >1 )
// TODO which is the minimum scale? (> 0, >= 0, >= 1, >1 )
if ( scale < 1 || ( prob = extract( nbLayers, layersName, layersFactor, bbox[0], bbox[1], bbox[2], bbox[3], scale,
#ifdef _EXPORT_MAP_
& svgmap
@@ -191,7 +191,7 @@ namespace pal
* @param lambda_max xMax bounding-box
* @param phi_max yMax bounding-box
* @param scale the scale (1:scale)
* @param svgmap stream to wrtie the svg map (need _EXPORT_MAP_ #defined to work)
* @param svgmap stream to wrtie the svg map (need _EXPORT_MAP_ defined to work)
*/
Problem* extract( int nbLayers, char **layersName, double *layersFactor,
double lambda_min, double phi_min,
@@ -46,14 +46,15 @@ class CORE_EXPORT QgsExpressionFieldBuffer
/**
* Add an expression to the buffer
*
* @param exp Expression to add
* @param exp expression to add
* @param fld field to add
*/
void addExpression( const QString& exp, const QgsField& fld );

/**
* Remove an expression from the buffer
*
* @param exp Expression to remove
* @param index index of expression to remove
*/
void removeExpression( int index );

@@ -634,6 +634,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
* Add a new field which is calculated by the expression specified
*
* @param exp The expression which calculates the field
* @param fld The field to calculate
*
* @note added in 2.6
*/
@@ -533,7 +533,7 @@ class GUI_EXPORT QgisInterface : public QObject
/** @note added in 1.9 */
virtual QAction *actionCancelAllEdits() = 0;
virtual QAction *actionLayerSaveAs() = 0;
/** @note deprecated in 2.4 - returns null pointer */
/** @deprecated in 2.4 - returns null pointer */
#ifndef Q_MOC_RUN
Q_DECL_DEPRECATED
#endif

0 comments on commit a2a66ea

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