Skip to content

Commit

Permalink
Fix doxygen blocks which don't use the * prefix on all lines, which
Browse files Browse the repository at this point in the history
prevents the auto format and sipify scripts from doing their full
formatting magic
  • Loading branch information
nyalldawson committed Apr 19, 2021
1 parent 352856f commit ffa99b7
Show file tree
Hide file tree
Showing 80 changed files with 455 additions and 460 deletions.
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class QgsNineCellFilter
%Docstring(signature="appended") %Docstring(signature="appended")
Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on
the cell value and the eight neighbour cells. the cell value and the eight neighbour cells.

Common examples are slope and aspect calculation in DEMs. Subclasses only implement Common examples are slope and aspect calculation in DEMs. Subclasses only implement
the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass
%End %End
Expand Down
17 changes: 8 additions & 9 deletions python/core/auto_generated/expression/qgsexpression.sip.in
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@







class QgsExpression class QgsExpression
{ {
%Docstring(signature="appended") %Docstring(signature="appended")
Expand All @@ -20,15 +19,15 @@ The expressions try to follow both syntax and semantics of SQL expressions.
Usage: Usage:
.. code-block:: python .. code-block:: python


exp = QgsExpression("gid*2 > 10 and type not in ('D','F')") exp = QgsExpression("gid*2 > 10 and type not in ('D','F')")
if exp.hasParserError(): if exp.hasParserError():
# show error message with parserErrorString() and exit # show error message with parserErrorString() and exit


result = exp.evaluate(feature, fields) result = exp.evaluate(feature, fields)
if exp.hasEvalError(): if exp.hasEvalError():
# show error message with evalErrorString() # show error message with evalErrorString()
else: else:
# examine the result # examine the result


Three Value Logic Three Value Logic
----------------- -----------------
Expand Down
1 change: 0 additions & 1 deletion python/core/auto_generated/qgsapplication.sip.in
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@







class QgsApplication : QApplication class QgsApplication : QApplication
{ {
%Docstring(signature="appended") %Docstring(signature="appended")
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgspythonrunner.sip.in
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ will then work as expected.
static bool isValid(); static bool isValid();
%Docstring %Docstring
Returns ``True`` if the runner has an instance Returns ``True`` if the runner has an instance
(and thus is able to run commands) * (and thus is able to run commands)
%End %End


static bool run( const QString &command, const QString &messageOnError = QString() ); static bool run( const QString &command, const QString &messageOnError = QString() );
Expand Down
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ class QgsVectorLayerEditBuffer : QObject
Returns ``True`` if the provider has been modified since the last commit Returns ``True`` if the provider has been modified since the last commit
%End %End



virtual bool addFeature( QgsFeature &f ); virtual bool addFeature( QgsFeature &f );
%Docstring %Docstring
Adds a feature Adds a feature
Expand Down Expand Up @@ -71,13 +70,13 @@ Changes values of attributes (but does not commit it).


virtual bool addAttribute( const QgsField &field ); virtual bool addAttribute( const QgsField &field );
%Docstring %Docstring
Add an attribute field (but does not commit it) Adds an attribute field (but does not commit it)
returns true if the field was added returns ``True`` if the field was added
%End %End


virtual bool deleteAttribute( int attr ); virtual bool deleteAttribute( int attr );
%Docstring %Docstring
Delete an attribute field (but does not commit it) Deletes an attribute field (but does not commit it)
%End %End


virtual bool renameAttribute( int attr, const QString &newName ); virtual bool renameAttribute( int attr, const QString &newName );
Expand Down
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ Returns the selected features in the attribute table in table sorted order.
.. versionadded:: 3.4 .. versionadded:: 3.4
%End %End



void scrollToFeature( const QgsFeatureId &fid, int column = -1 ); void scrollToFeature( const QgsFeatureId &fid, int column = -1 );
%Docstring %Docstring
Scroll to a feature with a given ``fid``. Scroll to a feature with a given ``fid``.
Expand All @@ -79,7 +78,6 @@ Optionally a ``column`` can be specified, which will also bring that column into
.. versionadded:: 3.16 .. versionadded:: 3.16
%End %End



protected: protected:


virtual void mousePressEvent( QMouseEvent *event ); virtual void mousePressEvent( QMouseEvent *event );
Expand Down
6 changes: 6 additions & 0 deletions scripts/doxygen_space.pl
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -133,6 +133,12 @@
print $out_handle $BUFFERED_LINE."\n"; print $out_handle $BUFFERED_LINE."\n";
$BUFFERED_LINE = ""; $BUFFERED_LINE = "";
} }

if ($new_line !~ m/^\s*\*/ && $new_line =~ m/^(\s*?)(\s?)(.+?)$/ )
{
$new_line = "$1* $3";
}

print $out_handle $new_line."\n"; print $out_handle $new_line."\n";
# print $out_handle "normal dox\n"; # print $out_handle "normal dox\n";
$PREVIOUS_WAS_DOX_BLANKLINE = 0; $PREVIOUS_WAS_DOX_BLANKLINE = 0;
Expand Down
4 changes: 2 additions & 2 deletions src/3d/qgs3dutils.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ class _3D_EXPORT Qgs3DUtils
static void extractPointPositions( const QgsFeature &f, const Qgs3DMapSettings &map, Qgs3DTypes::AltitudeClamping altClamp, QVector<QVector3D> &positions ); static void extractPointPositions( const QgsFeature &f, const Qgs3DMapSettings &map, Qgs3DTypes::AltitudeClamping altClamp, QVector<QVector3D> &positions );


/** /**
Returns true if bbox is completely outside the current viewing volume. * Returns TRUE if bbox is completely outside the current viewing volume.
This is used to perform object culling checks. * This is used to perform object culling checks.
*/ */
static bool isCullable( const QgsAABB &bbox, const QMatrix4x4 &viewProjectionMatrix ); static bool isCullable( const QgsAABB &bbox, const QMatrix4x4 &viewProjectionMatrix );


Expand Down
3 changes: 2 additions & 1 deletion src/analysis/raster/qgsninecellfilter.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ class QgsFeedback;
/** /**
* \ingroup analysis * \ingroup analysis
* \brief Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on * \brief Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on
the cell value and the eight neighbour cells. * the cell value and the eight neighbour cells.
*
* Common examples are slope and aspect calculation in DEMs. Subclasses only implement * Common examples are slope and aspect calculation in DEMs. Subclasses only implement
* the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass * the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass
*/ */
Expand Down
3 changes: 2 additions & 1 deletion src/app/georeferencer/qgsresidualplotitem.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@


/** /**
* A composer item to visualise the distribution of georeference residuals. For the visualisation, * A composer item to visualise the distribution of georeference residuals. For the visualisation,
the length of the residual arrows are scaled*/ * the length of the residual arrows are scaled.
*/
class QgsResidualPlotItem: public QgsLayoutItem class QgsResidualPlotItem: public QgsLayoutItem
{ {
Q_OBJECT Q_OBJECT
Expand Down
12 changes: 2 additions & 10 deletions src/app/qgisapp.cpp
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -494,15 +494,7 @@ class QgsUserProfile;


/** /**
* Set the application title bar text * Set the application title bar text

*/
If the current project title is null
if the project file is null then
set title text to just application name
else
set set title text to the project file name
else
set the title text to project title
*/
static void setTitleBarText_( QWidget &qgisApp ) static void setTitleBarText_( QWidget &qgisApp )
{ {
QString caption; QString caption;
Expand Down Expand Up @@ -548,7 +540,7 @@ static void setTitleBarText_( QWidget &qgisApp )
} }


/** /**
Creator function for output viewer * Creator function for output viewer
*/ */
static QgsMessageOutput *messageOutputViewer_() static QgsMessageOutput *messageOutputViewer_()
{ {
Expand Down
38 changes: 19 additions & 19 deletions src/app/qgisapp.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -240,8 +240,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow


/** /**
* Open the specified project file; prompt to save previous project if necessary. * Open the specified project file; prompt to save previous project if necessary.
Used to process a commandline argument, FileOpen or Drop event. * Used to process a commandline argument, FileOpen or Drop event.
*/ */
void openProject( const QString &fileName ); void openProject( const QString &fileName );


void openLayerDefinition( const QString &filename ); void openLayerDefinition( const QString &filename );
Expand Down Expand Up @@ -1105,7 +1105,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
*/ */
QgsBrowserGuiModel *browserModel(); QgsBrowserGuiModel *browserModel();


/* /**
* Change data source for \a layer, a data source selection dialog * Change data source for \a layer, a data source selection dialog
* will be opened and if accepted the data selected source will be * will be opened and if accepted the data selected source will be
* applied. * applied.
Expand All @@ -1117,22 +1117,22 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow


/** /**
* Add a raster layer directly without prompting user for location * Add a raster layer directly without prompting user for location
The caller must provide information compatible with the provider plugin * The caller must provide information compatible with the provider plugin
using the \a uri and \a baseName. The provider can use these * using the \a uri and \a baseName. The provider can use these
parameters in any way necessary to initialize the layer. The \a baseName * parameters in any way necessary to initialize the layer. The \a baseName
parameter is used in the Map Legend so it should be formed in a meaningful * parameter is used in the Map Legend so it should be formed in a meaningful
way. * way.
*/ */
QgsRasterLayer *addRasterLayer( QString const &uri, QString const &baseName, QString const &providerKey ); QgsRasterLayer *addRasterLayer( QString const &uri, QString const &baseName, QString const &providerKey );


/** /**
* Add a vector layer directly without prompting user for location * Add a vector layer directly without prompting user for location
The caller must provide information compatible with the provider plugin * The caller must provide information compatible with the provider plugin
using the \a vectorLayerPath and \a baseName. The provider can use these * using the \a vectorLayerPath and \a baseName. The provider can use these
parameters in any way necessary to initialize the layer. The \a baseName * parameters in any way necessary to initialize the layer. The \a baseName
parameter is used in the Map Legend so it should be formed in a meaningful * parameter is used in the Map Legend so it should be formed in a meaningful
way. * way.
*/ */
QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ); QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey );


/** /**
Expand Down Expand Up @@ -2469,14 +2469,14 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow


/** /**
* String containing supporting vector file formats * String containing supporting vector file formats
Suitable for a QFileDialog file filter. Build in ctor. * Suitable for a QFileDialog file filter. Build in ctor.
*/ */
QString mVectorFileFilter; QString mVectorFileFilter;


/** /**
* String containing supporting raster file formats * String containing supporting raster file formats
Suitable for a QFileDialog file filter. Build in ctor. * Suitable for a QFileDialog file filter. Build in ctor.
*/ */
QString mRasterFileFilter; QString mRasterFileFilter;


//! Timer for map tips //! Timer for map tips
Expand Down
6 changes: 4 additions & 2 deletions src/app/qgsannotationwidget.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -27,8 +27,10 @@ class QgsMarkerSymbol;
class QgsFillSymbol; class QgsFillSymbol;


/** /**
* A configuration widget to configure the annotation item properties. Usually embedded by QgsAnnotation * A configuration widget to configure the annotation item properties.
subclass configuration dialogs*/ *
* Usually embedded by QgsAnnotation subclass configuration dialogs.
*/
class APP_EXPORT QgsAnnotationWidget: public QWidget, private Ui::QgsAnnotationWidgetBase class APP_EXPORT QgsAnnotationWidget: public QWidget, private Ui::QgsAnnotationWidgetBase
{ {
Q_OBJECT Q_OBJECT
Expand Down
26 changes: 13 additions & 13 deletions src/app/qgsclipboard.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -64,45 +64,45 @@ class APP_EXPORT QgsClipboard : public QObject
QgsClipboard(); QgsClipboard();


/** /**
* Place a copy of the selected features from the specified layer on * Place a copy of the selected features from the specified layer on
* the internal clipboard, destroying the previous contents. * the internal clipboard, destroying the previous contents.
*/ */
void replaceWithCopyOf( QgsVectorLayer *src ); void replaceWithCopyOf( QgsVectorLayer *src );


/** /**
* Place a copy of features on the internal clipboard, * Place a copy of features on the internal clipboard,
* destroying the previous contents. * destroying the previous contents.
*/ */
void replaceWithCopyOf( QgsFeatureStore &featureStore ); void replaceWithCopyOf( QgsFeatureStore &featureStore );


/** /**
* Returns a copy of features on the internal clipboard. * Returns a copy of features on the internal clipboard.
*/ */
QgsFeatureList copyOf( const QgsFields &fields = QgsFields() ) const; QgsFeatureList copyOf( const QgsFields &fields = QgsFields() ) const;


/** /**
* Clears the internal clipboard. * Clears the internal clipboard.
*/ */
void clear(); void clear();


/** /**
* Inserts a copy of the feature on the internal clipboard. * Inserts a copy of the feature on the internal clipboard.
*/ */
void insert( const QgsFeature &feature ); void insert( const QgsFeature &feature );


/** /**
* Returns TRUE if the internal clipboard is empty, else FALSE. * Returns TRUE if the internal clipboard is empty, else FALSE.
*/ */
bool isEmpty() const; bool isEmpty() const;


/** /**
* Returns a copy of features on the internal clipboard, transformed * Returns a copy of features on the internal clipboard, transformed
* from the clipboard CRS to the destCRS. * from the clipboard CRS to the destCRS.
*/ */
QgsFeatureList transformedCopyOf( const QgsCoordinateReferenceSystem &destCRS, const QgsFields &fields = QgsFields() ) const; QgsFeatureList transformedCopyOf( const QgsCoordinateReferenceSystem &destCRS, const QgsFields &fields = QgsFields() ) const;


/** /**
* Get the clipboard CRS * Get the clipboard CRS
*/ */
QgsCoordinateReferenceSystem crs() const; QgsCoordinateReferenceSystem crs() const;


Expand Down Expand Up @@ -171,8 +171,8 @@ class APP_EXPORT QgsClipboard : public QObject


/** /**
* QGIS-internal vector feature clipboard. * QGIS-internal vector feature clipboard.
Stored as values not pointers as each clipboard operation * Stored as values not pointers as each clipboard operation
involves a deep copy anyway. * involves a deep copy anyway.
*/ */
QgsFeatureList mFeatureClipboard; QgsFeatureList mFeatureClipboard;
QgsFields mFeatureFields; QgsFields mFeatureFields;
Expand Down
4 changes: 3 additions & 1 deletion src/app/qgscustomprojectiondialog.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
class QDir; class QDir;


/** /**
The custom projection widget is used to define the projection family, ellipsoid and parameters needed by proj4 to assemble a customized projection definition. The resulting projection will be store in an sqlite backend. * The custom projection widget is used to define the projection family, ellipsoid and parameters needed by proj4 to assemble a customized projection definition.
*
* The resulting projection will be stored in an sqlite backend.
*/ */
class APP_EXPORT QgsCustomProjectionDialog : public QDialog, private Ui::QgsCustomProjectionDialogBase class APP_EXPORT QgsCustomProjectionDialog : public QDialog, private Ui::QgsCustomProjectionDialogBase
{ {
Expand Down
4 changes: 2 additions & 2 deletions src/app/qgsmaptooladdcircle.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ class APP_EXPORT QgsMapToolAddCircle: public QgsMapToolCapture


/** /**
* The parent map tool, e.g. the add feature tool. * The parent map tool, e.g. the add feature tool.
* Completed circle will be added to this tool by calling its addCurve() method. * Completed circle will be added to this tool by calling its addCurve() method.
**/ */
QgsMapToolCapture *mParentTool = nullptr; QgsMapToolCapture *mParentTool = nullptr;
//! Circle points (in map coordinates) //! Circle points (in map coordinates)
QgsPointSequence mPoints; QgsPointSequence mPoints;
Expand Down
4 changes: 2 additions & 2 deletions src/app/qgsmaptooladdellipse.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ class APP_EXPORT QgsMapToolAddEllipse: public QgsMapToolCapture


/** /**
* The parent map tool, e.g. the add feature tool. * The parent map tool, e.g. the add feature tool.
* Completed ellipse will be added to this tool by calling its toLineString() method. * Completed ellipse will be added to this tool by calling its toLineString() method.
**/ */
QgsMapToolCapture *mParentTool = nullptr; QgsMapToolCapture *mParentTool = nullptr;
//! Ellipse points (in map coordinates) //! Ellipse points (in map coordinates)
QgsPointSequence mPoints; QgsPointSequence mPoints;
Expand Down
4 changes: 2 additions & 2 deletions src/app/qgsmaptooladdrectangle.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ class APP_EXPORT QgsMapToolAddRectangle: public QgsMapToolCapture


/** /**
* The parent map tool, e.g. the add feature tool. * The parent map tool, e.g. the add feature tool.
* Completed regular shape will be added to this tool by calling its addCurve() method. * Completed regular shape will be added to this tool by calling its addCurve() method.
**/ */
QgsMapToolCapture *mParentTool = nullptr; QgsMapToolCapture *mParentTool = nullptr;
//! Regular Shape points (in map coordinates) //! Regular Shape points (in map coordinates)
QgsPointSequence mPoints; QgsPointSequence mPoints;
Expand Down
4 changes: 2 additions & 2 deletions src/app/qgsmaptooladdregularpolygon.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ class APP_EXPORT QgsMapToolAddRegularPolygon: public QgsMapToolCapture


/** /**
* The parent map tool, e.g. the add feature tool. * The parent map tool, e.g. the add feature tool.
* Completed regular polygon will be added to this tool by calling its addCurve() method. * Completed regular polygon will be added to this tool by calling its addCurve() method.
**/ */
QgsMapToolCapture *mParentTool = nullptr; QgsMapToolCapture *mParentTool = nullptr;
//! Regular Shape points (in map coordinates) //! Regular Shape points (in map coordinates)
QgsPointSequence mPoints; QgsPointSequence mPoints;
Expand Down
Loading

0 comments on commit ffa99b7

Please sign in to comment.