Skip to content
Permalink
Browse files
@brief -> \brief
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent 0f6452c commit 04d5862bad8998fe4d3bbbe142fa4b57e622f753
Showing with 243 additions and 243 deletions.
  1. +3 −3 src/analysis/openstreetmap/qgsosmdownload.h
  2. +1 −1 src/analysis/openstreetmap/qgsosmimport.h
  3. +1 −1 src/analysis/raster/qgsalignraster.h
  4. +1 −1 src/app/qgisappstylesheet.h
  5. +1 −1 src/app/qgsfieldsproperties.h
  6. +2 −2 src/app/qgsstatusbarscalewidget.h
  7. +1 −1 src/app/qgsvectorlayerproperties.h
  8. +5 −5 src/core/geometry/qgsgeometryutils.h
  9. +1 −1 src/core/geometry/qgstriangle.h
  10. +2 −2 src/core/qgsapplication.h
  11. +1 −1 src/core/qgsattributes.h
  12. +2 −2 src/core/qgscachedfeatureiterator.h
  13. +2 −2 src/core/qgscacheindex.h
  14. +26 −26 src/core/qgsconditionalstyle.h
  15. +1 −1 src/core/qgsdataitem.h
  16. +1 −1 src/core/qgsdatumtransformstore.h
  17. +2 −2 src/core/qgsexpression.h
  18. +1 −1 src/core/qgslabelfeature.h
  19. +3 −3 src/core/qgslabelingengine.h
  20. +1 −1 src/core/qgslayerdefinition.h
  21. +1 −1 src/core/qgslegendrenderer.h
  22. +1 −1 src/core/qgslegendsettings.h
  23. +7 −7 src/core/qgsmaplayermodel.h
  24. +4 −4 src/core/qgsmaplayerproxymodel.h
  25. +7 −7 src/core/qgsmapsettings.h
  26. +1 −1 src/core/qgsmultirenderchecker.h
  27. +1 −1 src/core/qgsogcutils.h
  28. +1 −1 src/core/qgspointlocator.h
  29. +6 −6 src/core/qgsproject.h
  30. +7 −7 src/core/qgsruntimeprofiler.h
  31. +1 −1 src/core/qgssnappingconfig.h
  32. +3 −3 src/core/qgssqlstatement.h
  33. +1 −1 src/core/qgsvectorlayer.h
  34. +9 −9 src/core/qgsvectorlayercache.h
  35. +1 −1 src/core/qgsvectorlayerdiagramprovider.h
  36. +1 −1 src/core/qgsvectorlayerlabelprovider.h
  37. +1 −1 src/core/qgswebframe.h
  38. +2 −2 src/core/qgswebpage.h
  39. +1 −1 src/core/qgswebview.h
  40. +6 −6 src/core/raster/qgshillshaderenderer.h
  41. +1 −1 src/gui/attributetable/qgsattributetablemodel.h
  42. +4 −4 src/gui/attributetable/qgsattributetableview.h
  43. +3 −3 src/gui/attributetable/qgsdualview.h
  44. +3 −3 src/gui/attributetable/qgsfeaturelistmodel.h
  45. +2 −2 src/gui/attributetable/qgsfeaturelistview.h
  46. +2 −2 src/gui/attributetable/qgsfieldconditionalformatwidget.h
  47. +2 −2 src/gui/editorwidgets/core/qgseditorconfigwidget.h
  48. +1 −1 src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
  49. +2 −2 src/gui/editorwidgets/core/qgswidgetwrapper.h
  50. +3 −3 src/gui/editorwidgets/qgsdatetimeedit.h
  51. +1 −1 src/gui/editorwidgets/qgsdoublespinbox.h
  52. +1 −1 src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h
  53. +1 −1 src/gui/editorwidgets/qgsspinbox.h
  54. +1 −1 src/gui/layertree/qgslayertreeembeddedwidgetsimpl.h
  55. +1 −1 src/gui/qgsadvanceddigitizingcanvasitem.h
  56. +3 −3 src/gui/qgsadvanceddigitizingdockwidget.h
  57. +1 −1 src/gui/qgsattributedialog.h
  58. +2 −2 src/gui/qgsexpressionlineedit.h
  59. +4 −4 src/gui/qgsexternalresourcewidget.h
  60. +2 −2 src/gui/qgsfieldcombobox.h
  61. +4 −4 src/gui/qgsfieldexpressionwidget.h
  62. +1 −1 src/gui/qgsfieldmodel.h
  63. +2 −2 src/gui/qgsfieldproxymodel.h
  64. +6 −6 src/gui/qgsfilewidget.h
  65. +1 −1 src/gui/qgshelp.h
  66. +5 −5 src/gui/qgsidentifymenu.h
  67. +2 −2 src/gui/qgsmaplayercombobox.h
  68. +2 −2 src/gui/qgsmaplayerconfigwidget.h
  69. +4 −4 src/gui/qgsmaplayerconfigwidgetfactory.h
  70. +2 −2 src/gui/qgsmaplayerstylemanagerwidget.h
  71. +2 −2 src/gui/qgsmapmouseevent.h
  72. +1 −1 src/gui/qgsmaptooladvanceddigitizing.h
  73. +2 −2 src/gui/qgsmaptoolidentifyfeature.h
  74. +2 −2 src/gui/qgsoptionswidgetfactory.h
  75. +5 −5 src/gui/qgspanelwidget.h
  76. +1 −1 src/gui/qgspixmaplabel.h
  77. +1 −1 src/gui/qgsscalerangewidget.h
  78. +1 −1 src/gui/qgsuserinputdockwidget.h
  79. +7 −7 src/gui/raster/qgshillshaderendererwidget.h
  80. +2 −2 src/gui/raster/qgsrastertransparencywidget.h
  81. +1 −1 src/gui/raster/qgsrendererrasterpropertieswidget.h
  82. +7 −7 src/gui/symbology-ng/qgsstyleexportimportdialog.h
  83. +1 −1 src/gui/symbology-ng/qgsstylegroupselectiondialog.h
  84. +2 −2 src/gui/symbology-ng/qgssvgselectorwidget.h
  85. +2 −2 src/gui/symbology-ng/qgssymbolselectordialog.h
  86. +2 −2 src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h
  87. +1 −1 src/plugins/grass/qtermwidget/ColorScheme.h
  88. +1 −1 src/plugins/grass/qtermwidget/qtermwidget.h
  89. +1 −1 src/providers/arcgisrest/qgsafsprovider.h
  90. +4 −4 src/providers/db2/qgsdb2dataitems.h
  91. +1 −1 src/providers/db2/qgsdb2geometrycolumns.h
  92. +1 −1 src/providers/db2/qgsdb2newconnection.h
  93. +1 −1 src/providers/db2/qgsdb2provider.h
  94. +1 −1 src/providers/mssql/qgsmssqlnewconnection.h
  95. +2 −2 src/providers/ogr/qgsogrconnpool.h
  96. +1 −1 src/server/qgsserver.h
  97. +1 −1 src/server/qgsserverplugins.h
@@ -25,7 +25,7 @@
class QgsRectangle;

/** \ingroup analysis
* @brief OSMDownload is a utility class for downloading OpenStreetMap via Overpass API.
* \brief OSMDownload is a utility class for downloading OpenStreetMap via Overpass API.
*
* To use this class, it is necessary to set query, output file name and start the request.
* The interface is asynchronous, the caller has to wait for finished() signal that is
@@ -64,7 +64,7 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject
QString errorString() const { return mError; }

/**
* @brief Starts network request for data. The prerequisite is that the query string and output
* \brief Starts network request for data. The prerequisite is that the query string and output
* file name have been set.
*
* Only one request may be pending at one point - if you need more requests at once, use several instances.
@@ -74,7 +74,7 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject
bool start();

/**
* @brief Aborts current pending request
* \brief Aborts current pending request
* \returns true if there is a pending request and has been aborted, false otherwise
*/
bool abort();
@@ -25,7 +25,7 @@
class QXmlStreamReader;

/** \ingroup analysis
* @brief The QgsOSMXmlImport class imports OpenStreetMap XML format to our topological representation
* \brief The QgsOSMXmlImport class imports OpenStreetMap XML format to our topological representation
* in a SQLite database (see QgsOSMDatabase for details).
*
* How to use the class:
@@ -29,7 +29,7 @@ typedef void *GDALDatasetH;


/** \ingroup analysis
* @brief QgsAlignRaster takes one or more raster layers and warps (resamples) them
* \brief QgsAlignRaster takes one or more raster layers and warps (resamples) them
* so they have the same:
* - coordinate reference system
* - cell size and raster size
@@ -24,7 +24,7 @@
#include "qgis_app.h"

/** \class QgisAppStyleSheet
* @brief Adjustable stylesheet for the Qgis application
* \brief Adjustable stylesheet for the Qgis application
*/
class APP_EXPORT QgisAppStyleSheet: public QObject
{
@@ -159,7 +159,7 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope
QTreeWidgetItem *loadAttributeEditorTreeItem( QgsAttributeEditorElement *const widgetDef, QTreeWidgetItem *parent );

/**
* @brief setEditFormInit set the private ui fields
* \brief setEditFormInit set the private ui fields
* \param editForm
* \param initFunction
* \param initCode
@@ -44,13 +44,13 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget
virtual ~QgsStatusBarScaleWidget();

/**
* @brief setScale set the selected scale from double
* \brief setScale set the selected scale from double
* \param scale
*/
void setScale( double scale );

/**
* @brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out
* \brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out
* \returns True if the scale shall be locked
*/
bool isLocked() const;
@@ -139,7 +139,7 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private
void updateVariableEditor();

/**
* @brief updates the FieldsPropertiesDialog when syncing the layer properties
* \brief updates the FieldsPropertiesDialog when syncing the layer properties
*/
void updateFieldsPropertiesDialog();

@@ -77,7 +77,7 @@ class CORE_EXPORT QgsGeometryUtils
static double sqrDistToLine( double ptX, double ptY, double x1, double y1, double x2, double y2, double &minDistX, double &minDistY, double epsilon );

/**
* @brief Compute the intersection between two lines
* \brief Compute the intersection between two lines
* \param p1 Point on the first line
* \param v Direction vector of the first line
* \param q1 Point on the second line
@@ -88,7 +88,7 @@ class CORE_EXPORT QgsGeometryUtils
static bool lineIntersection( const QgsPointV2 &p1, QgsVector v, const QgsPointV2 &q1, QgsVector w, QgsPointV2 &inter );

/**
* @brief Compute the intersection between two segments
* \brief Compute the intersection between two segments
* \param p1 First segment start point
* \param p2 First segment end point
* \param q1 Second segment start point
@@ -100,7 +100,7 @@ class CORE_EXPORT QgsGeometryUtils
static bool segmentIntersection( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &q1, const QgsPointV2 &q2, QgsPointV2 &inter, double tolerance );

/**
* @brief Project the point on a segment
* \brief Project the point on a segment
* \param p The point
* \param s1 The segment start point
* \param s2 The segment end point
@@ -123,7 +123,7 @@ class CORE_EXPORT QgsGeometryUtils
};

/**
* @brief Find self intersections in a polyline
* \brief Find self intersections in a polyline
* \param geom The geometry to check
* \param part The part of the geometry to check
* \param ring The ring of the geometry part to check
@@ -310,7 +310,7 @@ class CORE_EXPORT QgsGeometryUtils
static void coefficients( const QgsPointV2 &pt1, const QgsPointV2 &pt2, double &a, double &b, double &c );

/**
* @brief Create a perpendicular line segment from p to segment [s1, s2]
* \brief Create a perpendicular line segment from p to segment [s1, s2]
* \param p The point
* \param s1 The segment start point
* \param s2 The segment end point
@@ -309,7 +309,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
private:

/**
* @brief Convenient method checking the validity of geometry (no duplicate point(s), no colinearity).
* \brief Convenient method checking the validity of geometry (no duplicate point(s), no colinearity).
* \param p1 first point
* \param p2 second point
* \param p3 third point
@@ -101,7 +101,7 @@ class CORE_EXPORT QgsApplication : public QApplication
static QString themeName();

/**
* @brief Set the current UI theme used to style the interface. Use uiThemes() to
* \brief Set the current UI theme used to style the interface. Use uiThemes() to
* find valid themes to use. Variables found in variables.qss will be added to the stylesheet
* on load.
* \param themeName The name of the theme.
@@ -110,7 +110,7 @@ class CORE_EXPORT QgsApplication : public QApplication
static void setUITheme( const QString &themeName );

/**
* @brief All themes found in ~/.qgis3/themes folder.
* \brief All themes found in ~/.qgis3/themes folder.
* The path is to the root folder for the theme
* \note Valid theme folders must contain a style.qss file.
* \returns A hash of theme name and theme path. Valid theme folders contain style.qss
@@ -88,7 +88,7 @@ class CORE_EXPORT QgsAttributes : public QVector<QVariant>
{}

/**
* @brief Compares two vectors of attributes.
* \brief Compares two vectors of attributes.
* They are considered equal if all their members contain the same value and NULL flag.
* This was introduced because the default Qt implementation of QVariant comparison does not
* handle NULL values for certain types (like int).
@@ -23,7 +23,7 @@
class QgsVectorLayerCache;

/** \ingroup core
* @brief
* \brief
* Delivers features from the cache
*
*/
@@ -81,7 +81,7 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator
};

/** \ingroup core
* @brief
* \brief
* Uses another iterator as backend and writes features to the cache
*
*/
@@ -23,7 +23,7 @@ class QgsFeatureRequest;
class QgsFeatureIterator;

/** \ingroup core
* @brief
* \brief
* Abstract base class for cache indices
*/

@@ -50,7 +50,7 @@ class CORE_EXPORT QgsAbstractCacheIndex
virtual void flush() = 0;

/**
* @brief
* \brief
* Implement this method to update the the indices, in case you need information contained by the request
* to properly index. (E.g. spatial index)
* Does nothing by default
Loading

0 comments on commit 04d5862

Please sign in to comment.