Skip to content

Commit

Permalink
Standardise some since annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Aug 31, 2024
1 parent 2af54ad commit d318cdb
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1484,7 +1484,7 @@ Evaluates the parameter with matching ``definition`` and ``value`` to a list of
%Docstring
Evaluates the parameter with matching ``definition`` to a list of strings (e.g. field names or point cloud attributes).

.. versionadded:: 3.32.
.. versionadded:: 3.32
%End

static QStringList parameterAsStrings( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
Expand Down
2 changes: 1 addition & 1 deletion python/PyQt6/gui/auto_generated/qgsnewnamedialog.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ New dialog constructor.

Earlier versions had a similar constructor but with extra arguments for ``regexp`` which were removed in QGIS 3.22 as they relied on the deprecated QRegExp class. Use :py:func:`~QgsNewNameDialog.setRegularExpression` instead.

.. versionadded:: 3.22.
.. versionadded:: 3.22
%End

void setHintString( const QString &hintString );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1484,7 +1484,7 @@ Evaluates the parameter with matching ``definition`` and ``value`` to a list of
%Docstring
Evaluates the parameter with matching ``definition`` to a list of strings (e.g. field names or point cloud attributes).

.. versionadded:: 3.32.
.. versionadded:: 3.32
%End

static QStringList parameterAsStrings( const QgsProcessingParameterDefinition *definition, const QVariant &value, QgsProcessingContext &context );
Expand Down
2 changes: 1 addition & 1 deletion python/gui/auto_generated/qgsnewnamedialog.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ New dialog constructor.

Earlier versions had a similar constructor but with extra arguments for ``regexp`` which were removed in QGIS 3.22 as they relied on the deprecated QRegExp class. Use :py:func:`~QgsNewNameDialog.setRegularExpression` instead.

.. versionadded:: 3.22.
.. versionadded:: 3.22
%End

void setHintString( const QString &hintString );
Expand Down
5 changes: 5 additions & 0 deletions scripts/doxygen_space.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ def process_file(file_path):
prefix, first, remaining = match.groups()
line = f'{prefix}//!< {first.upper()}{remaining}'

if match := re.match(r'^(.*)\\since (?:QGIS )?(\d+\.\d+(?:\.\d+)?)[.]?$', line):
# Standard since annotation
prefix, version = match.groups()
line = f'{prefix}\\since QGIS {version}'

if match := re.match(r'^(\s*)//!\s*(.*?)$', line):
indentation, comment = match.groups()
# found a //! comment
Expand Down
2 changes: 1 addition & 1 deletion src/core/processing/qgsprocessingparameters.h
Original file line number Diff line number Diff line change
Expand Up @@ -1580,7 +1580,7 @@ class CORE_EXPORT QgsProcessingParameters
/**
* Evaluates the parameter with matching \a definition to a list of strings (e.g. field names or point cloud attributes).
*
* \since QGIS 3.32.
* \since QGIS 3.32
*/
static QStringList parameterAsStrings( const QgsProcessingParameterDefinition *definition, const QVariantMap &parameters, QgsProcessingContext &context );

Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsnewnamedialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog
* \param parent parent widget
* \param flags window flags
* \note Earlier versions had a similar constructor but with extra arguments for \a regexp which were removed in QGIS 3.22 as they relied on the deprecated QRegExp class. Use setRegularExpression() instead.
* \since QGIS 3.22.
* \since QGIS 3.22
*/
QgsNewNameDialog( const QString &source = QString(), const QString &initial = QString(),
const QStringList &extensions = QStringList(), const QStringList &existing = QStringList(),
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/topology/dockModel.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class DockModel : public QAbstractTableModel

/**
* \param errorList reference to the ErrorList where errors will be stored
* \since 3.38
* \since QGIS 3.38
*/
void setErrors( const ErrorList &errorList );

Expand Down

0 comments on commit d318cdb

Please sign in to comment.