Skip to content

Commit

Permalink
[doxygen] remove remaining 'note Added in XXX' in favor of '\since ...'
Browse files Browse the repository at this point in the history
  • Loading branch information
3nids committed May 11, 2017
1 parent 8e60510 commit ad3fe26
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposerimageexportoptionsdialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@


/** A dialog for customising the properties of an exported image file.
* /note added in QGIS 2.12
* \since QGIS 2.12
*/
class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsComposerImageExportOptionsDialog
{
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposertablebackgroundcolorsdialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class QCheckBox;
class QgsColorButton;

/** A dialog for customisation of the cell background colors for a QgsComposerTableV2
* /note added in QGIS 2.12
* \since QGIS 2.12
*/
class QgsComposerTableBackgroundColorsDialog: public QDialog, private Ui::QgsComposerTableBackgroundDialog
{
Expand Down
6 changes: 3 additions & 3 deletions src/core/geometry/qgsgeometryutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ class CORE_EXPORT QgsGeometryUtils
static double circleTangentDirection( const QgsPointV2 &tangentPoint, const QgsPointV2 &cp1, const QgsPointV2 &cp2, const QgsPointV2 &cp3 );

/** Convert circular arc defined by p1, p2, p3 (p1/p3 being start resp. end point, p2 lies on the arc) into a sequence of points.
* @note added in 3.0
* \since 3.0
*/
static void segmentizeArc( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &p3,
QgsPointSequence SIP_PYTYPE( QList<QgsPointV2> ) &points SIP_OUT, double tolerance = M_PI_2 / 90,
Expand All @@ -184,12 +184,12 @@ class CORE_EXPORT QgsGeometryUtils

/** For line defined by points pt1 and pt3, find out on which side of the line is point pt3.
* Returns -1 if pt3 on the left side, 1 if pt3 is on the right side or 0 if pt3 lies on the line.
* @note added in 3.0
* \since 3.0
*/
static int segmentSide( const QgsPointV2 &pt1, const QgsPointV2 &pt3, const QgsPointV2 &pt2 );

/** Interpolate a value at given angle on circular arc given values (zm1, zm2, zm3) at three different angles (a1, a2, a3).
* @note added in 3.0
* \since 3.0
*/
static double interpolateArcValue( double angle, double a1, double a2, double a3, double zm1, double zm2, double zm3 );

Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsexpression.h
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ class CORE_EXPORT QgsExpression
* This can be used as callback for custom implementations of subclasses. It is the default for implementation
* for StaticFunction::isStatic.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
static bool allParamsStatic( const QgsExpression::NodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context );

Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsexpressioncontext.h
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ class CORE_EXPORT QgsExpressionContextScope
* Tests whether the variable with the specified \a name is static and can
* be cached.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
bool isStatic( const QString &name ) const;

Expand Down
6 changes: 3 additions & 3 deletions src/core/qgsstacktrace.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* displaying additional debug information when things go wrong.
*
* \note Not available in python
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsStackTrace
{
Expand Down Expand Up @@ -64,7 +64,7 @@ class CORE_EXPORT QgsStackTrace
/**
* Return a demangled stack backtrace of the caller function.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
static QVector<QgsStackTrace::StackLine> trace( struct _EXCEPTION_POINTERS *ExceptionInfo );

Expand All @@ -80,7 +80,7 @@ class CORE_EXPORT QgsStackTrace
/**
* Return a demangled stack backtrace of the caller function.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
static QVector<QgsStackTrace::StackLine> trace( unsigned int maxFrames = 63 );
#endif
Expand Down
4 changes: 2 additions & 2 deletions src/gui/qgsrubberband.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,13 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem

/**
* A diamond is used to highlight points (◇)
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
ICON_DIAMOND,

/**
* A diamond is used to highlight points (◆)
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
ICON_FULL_DIAMOND,
};
Expand Down

0 comments on commit ad3fe26

Please sign in to comment.