Skip to content
Permalink
Browse files

Fix doxygen blocks which don't use the * prefix on all lines, which

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 ffa99b7b646ed8a6a2cf00144cc2dfe98f868786
Showing with 455 additions and 460 deletions.
  1. +1 −0 python/analysis/auto_generated/raster/qgsninecellfilter.sip.in
  2. +8 −9 python/core/auto_generated/expression/qgsexpression.sip.in
  3. +0 −1 python/core/auto_generated/qgsapplication.sip.in
  4. +1 −1 python/core/auto_generated/qgspythonrunner.sip.in
  5. +3 −4 python/core/auto_generated/vector/qgsvectorlayereditbuffer.sip.in
  6. +0 −2 python/gui/auto_generated/attributetable/qgsattributetableview.sip.in
  7. +6 −0 scripts/doxygen_space.pl
  8. +2 −2 src/3d/qgs3dutils.h
  9. +2 −1 src/analysis/raster/qgsninecellfilter.h
  10. +2 −1 src/app/georeferencer/qgsresidualplotitem.h
  11. +2 −10 src/app/qgisapp.cpp
  12. +19 −19 src/app/qgisapp.h
  13. +4 −2 src/app/qgsannotationwidget.h
  14. +13 −13 src/app/qgsclipboard.h
  15. +3 −1 src/app/qgscustomprojectiondialog.h
  16. +2 −2 src/app/qgsmaptooladdcircle.h
  17. +2 −2 src/app/qgsmaptooladdellipse.h
  18. +2 −2 src/app/qgsmaptooladdrectangle.h
  19. +2 −2 src/app/qgsmaptooladdregularpolygon.h
  20. +4 −4 src/app/qgsmaptoolselectutils.h
  21. +1 −1 src/app/qgsprojectproperties.h
  22. +2 −2 src/app/vertextool/qgsvertextool.h
  23. +4 −2 src/auth/oauth2/qgso2.h
  24. +18 −18 src/core/auth/qgsauthmethodmetadata.h
  25. +5 −5 src/core/auth/qgsauthmethodregistry.cpp
  26. +50 −52 src/core/expression/qgsexpression.h
  27. +2 −2 src/core/mesh/qgsmeshdataprovidertemporalcapabilities.h
  28. +54 −57 src/core/project/qgsproject.cpp
  29. +17 −23 src/core/providers/gdal/qgsgdalprovider.cpp
  30. +14 −20 src/core/providers/ogr/qgsogrprovider.cpp
  31. +8 −9 src/core/qgsapplication.h
  32. +1 −1 src/core/qgsfeatureid.h
  33. +12 −12 src/core/qgsopenclutils.h
  34. +5 −5 src/core/qgsproviderregistry.cpp
  35. +2 −1 src/core/qgspythonrunner.h
  36. +1 −1 src/core/qgssqlstatement.h
  37. +1 −1 src/core/raster/qgsrasterdataprovider.h
  38. +5 −5 src/core/raster/qgsrasterdataprovidertemporalcapabilities.h
  39. +6 −6 src/core/raster/qgsrasterlayertemporalproperties.h
  40. +1 −1 src/core/raster/qgsrasterpipe.h
  41. +3 −3 src/core/vector/qgsvectordataprovidertemporalcapabilities.h
  42. +2 −2 src/core/vector/qgsvectorlayer.h
  43. +18 −19 src/core/vector/qgsvectorlayereditbuffer.h
  44. +4 −4 src/core/vector/qgsvectorlayertemporalproperties.h
  45. +3 −5 src/gui/attributetable/qgsattributetableview.h
  46. +1 −1 src/gui/mesh/qgsmeshrendereractivedatasetwidget.h
  47. +1 −1 src/gui/qgsblendmodecombobox.h
  48. +1 −1 src/gui/qgsencodingfiledialog.h
  49. +1 −1 src/gui/qgsexternalresourcewidget.h
  50. +1 −1 src/gui/qgsfilterlineedit.h
  51. +6 −7 src/gui/qgsguiutils.h
  52. +2 −0 src/gui/qgsmetadatawidget.cpp
  53. +3 −4 src/gui/qgsmetadatawidget.h
  54. +5 −5 src/gui/qgsproviderguiregistry.cpp
  55. +1 −1 src/gui/qgsscalecombobox.h
  56. +2 −2 src/gui/qgsscalewidget.h
  57. +0 −8 src/gui/raster/qgsrasterlayerproperties.h
  58. +3 −3 src/plugins/qgisplugin.h
  59. +1 −1 src/plugins/topology/topolTest.h
  60. +1 −1 src/providers/arcgisrest/qgsafsshareddata.h
  61. +4 −2 src/providers/db2/qgsdb2tablemodel.h
  62. +2 −3 src/providers/delimitedtext/qgsdelimitedtextfile.h
  63. +50 −35 src/providers/gpx/gpsdata.h
  64. +3 −4 src/providers/gpx/qgsgpxprovider.h
  65. +1 −1 src/providers/grass/qgsgrass.h
  66. +4 −4 src/providers/grass/qgsgrassrasterprovider.h
  67. +2 −3 src/providers/hana/qgshanaprovider.h
  68. +4 −2 src/providers/hana/qgshanatablemodel.h
  69. +2 −4 src/providers/mssql/qgsmssqlgeometryparser.h
  70. +2 −3 src/providers/mssql/qgsmssqlprovider.h
  71. +4 −2 src/providers/mssql/qgsmssqltablemodel.h
  72. +4 −2 src/providers/oracle/qgsoracletablemodel.h
  73. +4 −2 src/providers/postgres/qgspgtablemodel.h
  74. +4 −2 src/providers/spatialite/qgsspatialitetablemodel.h
  75. +5 −5 src/providers/wfs/qgswfsfeatureiterator.h
  76. +2 −2 src/providers/wfs/qgswfsprovider.h
  77. +4 −4 tests/qt_modeltest/dynamictreemodel.h
  78. +1 −1 tests/qt_modeltest/tst_modeltest.cpp
  79. +3 −3 tests/src/core/testqgscoordinatereferencesystem.cpp
  80. +4 −4 tests/src/gui/testqgsmaptoolzoom.cpp
@@ -15,6 +15,7 @@ class QgsNineCellFilter
%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
the cell value and the eight neighbour cells.

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
%End
@@ -10,7 +10,6 @@




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

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

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

Three Value Logic
-----------------
@@ -9,7 +9,6 @@




class QgsApplication : QApplication
{
%Docstring(signature="appended")
@@ -27,7 +27,7 @@ will then work as expected.
static bool isValid();
%Docstring
Returns ``True`` if the runner has an instance
(and thus is able to run commands) *
(and thus is able to run commands)
%End

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


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

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

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

virtual bool renameAttribute( int attr, const QString &newName );
@@ -69,7 +69,6 @@ Returns the selected features in the attribute table in table sorted order.
.. versionadded:: 3.4
%End


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


protected:

virtual void mousePressEvent( QMouseEvent *event );
@@ -133,6 +133,12 @@
print $out_handle $BUFFERED_LINE."\n";
$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 "normal dox\n";
$PREVIOUS_WAS_DOX_BLANKLINE = 0;
@@ -125,8 +125,8 @@ class _3D_EXPORT Qgs3DUtils
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.
This is used to perform object culling checks.
* Returns TRUE if bbox is completely outside the current viewing volume.
* This is used to perform object culling checks.
*/
static bool isCullable( const QgsAABB &bbox, const QMatrix4x4 &viewProjectionMatrix );

@@ -28,7 +28,8 @@ class QgsFeedback;
/**
* \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
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
* the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass
*/
@@ -22,7 +22,8 @@

/**
* 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
{
Q_OBJECT
@@ -494,15 +494,7 @@ class QgsUserProfile;

/**
* 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 )
{
QString caption;
@@ -548,7 +540,7 @@ static void setTitleBarText_( QWidget &qgisApp )
}

/**
Creator function for output viewer
* Creator function for output viewer
*/
static QgsMessageOutput *messageOutputViewer_()
{
@@ -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.
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 openLayerDefinition( const QString &filename );
@@ -1105,7 +1105,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
*/
QgsBrowserGuiModel *browserModel();

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

/**
* Add a raster layer directly without prompting user for location
The caller must provide information compatible with the provider plugin
using the \a uri and \a baseName. The provider can use these
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
way.
*/
* The caller must provide information compatible with the provider plugin
* using the \a uri and \a baseName. The provider can use these
* 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
* way.
*/
QgsRasterLayer *addRasterLayer( QString const &uri, QString const &baseName, QString const &providerKey );

/**
* Add a vector layer directly without prompting user for location
The caller must provide information compatible with the provider plugin
using the \a vectorLayerPath and \a baseName. The provider can use these
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
way.
*/
* The caller must provide information compatible with the provider plugin
* using the \a vectorLayerPath and \a baseName. The provider can use these
* 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
* way.
*/
QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey );

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

/**
* 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;

/**
* 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;

//! Timer for map tips
@@ -27,8 +27,10 @@ class QgsMarkerSymbol;
class QgsFillSymbol;

/**
* A configuration widget to configure the annotation item properties. Usually embedded by QgsAnnotation
subclass configuration dialogs*/
* A configuration widget to configure the annotation item properties.
*
* Usually embedded by QgsAnnotation subclass configuration dialogs.
*/
class APP_EXPORT QgsAnnotationWidget: public QWidget, private Ui::QgsAnnotationWidgetBase
{
Q_OBJECT
@@ -64,45 +64,45 @@ class APP_EXPORT QgsClipboard : public QObject
QgsClipboard();

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

/**
* Place a copy of features on the internal clipboard,
* destroying the previous contents.
* Place a copy of features on the internal clipboard,
* destroying the previous contents.
*/
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;

/**
* Clears the internal clipboard.
* Clears the internal clipboard.
*/
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 );

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

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

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

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

/**
* QGIS-internal vector feature clipboard.
Stored as values not pointers as each clipboard operation
involves a deep copy anyway.
* Stored as values not pointers as each clipboard operation
* involves a deep copy anyway.
*/
QgsFeatureList mFeatureClipboard;
QgsFields mFeatureFields;
@@ -26,7 +26,9 @@
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
{
@@ -51,8 +51,8 @@ class APP_EXPORT QgsMapToolAddCircle: public QgsMapToolCapture

/**
* 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;
//! Circle points (in map coordinates)
QgsPointSequence mPoints;
@@ -47,8 +47,8 @@ class APP_EXPORT QgsMapToolAddEllipse: public QgsMapToolCapture

/**
* 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;
//! Ellipse points (in map coordinates)
QgsPointSequence mPoints;
@@ -48,8 +48,8 @@ class APP_EXPORT QgsMapToolAddRectangle: public QgsMapToolCapture

/**
* 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;
//! Regular Shape points (in map coordinates)
QgsPointSequence mPoints;
@@ -56,8 +56,8 @@ class APP_EXPORT QgsMapToolAddRegularPolygon: public QgsMapToolCapture

/**
* 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;
//! Regular Shape points (in map coordinates)
QgsPointSequence mPoints;

0 comments on commit ffa99b7

Please sign in to comment.