Try to fix doxygen errors/warnings on Debian nightlies

qgis · Jan 10, 2016 · 17793c3 · 17793c3
1 parent 651ca51
commit 17793c3
Show file tree

Hide file tree

Showing 38 changed files with 41 additions and 62 deletions.
diff --git a/src/core/geometry/qgsgeos.cpp b/src/core/geometry/qgsgeos.cpp
@@ -49,8 +49,7 @@ email                : marco.hugentobler at sourcepole dot com
     return r; \
   }
 
-///@cond
-//not part of public API
+/// @cond PRIVATE
 
 static void throwGEOSException( const char *fmt, ... )
 {

diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h
@@ -152,7 +152,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
     static int geomDigits( const GEOSGeometry* geom );
 };
 
-/// @cond
+/// @cond PRIVATE
 
 class GEOSException
 {

diff --git a/src/core/qgsdatadefined_p.h b/src/core/qgsdatadefined_p.h
@@ -15,7 +15,7 @@
 #ifndef QGSDATADEFINED_PRIVATE_H
 #define QGSDATADEFINED_PRIVATE_H
 
-/// @cond
+/// @cond PRIVATE
 
 //
 //  W A R N I N G

diff --git a/src/core/qgsexpressioncontext.cpp b/src/core/qgsexpressioncontext.cpp
@@ -118,8 +118,7 @@ bool QgsExpressionContextScope::variableNameSort( const QString& a, const QStrin
   return QString::localeAwareCompare( a, b ) < 0;
 }
 
-// not public API
-/// @cond
+/// @cond PRIVATE
 class QgsExpressionContextVariableCompare
 {
   public:
@@ -496,8 +495,7 @@ void QgsExpressionContextUtils::setGlobalVariables( const QgsStringMap &variable
   settings.setValue( QString( "/variables/values" ), customVariableVariants );
 }
 
-///@cond
-//not part of public API
+/// @cond PRIVATE
 
 class GetNamedProjectColor : public QgsScopedExpressionFunction
 {

diff --git a/src/core/qgsfeature_p.h b/src/core/qgsfeature_p.h
@@ -16,7 +16,7 @@ email                : nyall dot dawson at gmail dot com
 #ifndef QGSFEATURE_PRIVATE_H
 #define QGSFEATURE_PRIVATE_H
 
-/// @cond
+/// @cond PRIVATE
 
 //
 //  W A R N I N G

diff --git a/src/core/qgsfeatureiterator.cpp b/src/core/qgsfeatureiterator.cpp
@@ -21,7 +21,7 @@
 #include <algorithm>
 
 
-/// @cond
+/// @cond PRIVATE
 class QgsExpressionSorter
 {
   public:

diff --git a/src/core/qgsfield_p.h b/src/core/qgsfield_p.h
@@ -16,7 +16,7 @@
 #ifndef QGSFIELD_PRIVATE_H
 #define QGSFIELD_PRIVATE_H
 
-/// @cond
+/// @cond PRIVATE
 
 //
 //  W A R N I N G

diff --git a/src/core/qgsnetworkaccessmanager.cpp b/src/core/qgsnetworkaccessmanager.cpp
@@ -38,8 +38,7 @@
 
 #include "qgsauthmanager.h"
 
-//not part of public API
-///@cond
+/// @cond PRIVATE
 //! @note not available in Python bindings
 class QgsNetworkProxyFactory : public QNetworkProxyFactory
 {

diff --git a/src/core/qgswebframe.h b/src/core/qgswebframe.h
@@ -30,7 +30,7 @@
  */
 class CORE_EXPORT QWebFrame : public QObject
 {
-/// @cond
+/// @cond NOT_STABLE_API
     Q_OBJECT
 
   public:

diff --git a/src/core/qgswebpage.h b/src/core/qgswebpage.h
@@ -35,7 +35,7 @@
  */
 class CORE_EXPORT QWebSettings : public QObject
 {
-/// @cond
+/// @cond NOT_STABLE_API
     Q_OBJECT
 
   public:
@@ -98,7 +98,7 @@ class CORE_EXPORT QWebSettings : public QObject
  */
 class CORE_EXPORT QWebPage : public QObject
 {
-/// @cond
+/// @cond NOT_STABLE_API
     Q_OBJECT
 
   public:

diff --git a/src/core/qgswebview.h b/src/core/qgswebview.h
@@ -54,7 +54,7 @@ class CORE_EXPORT QgsWebView : public QWebView
 class CORE_EXPORT QgsWebView : public QWidget
 {
 
-/// @cond
+/// @cond NOT_STABLE_API
     Q_OBJECT
   public:
     explicit QgsWebView( QWidget *parent = 0 )

diff --git a/src/core/symbology-ng/qgslinesymbollayerv2.cpp b/src/core/symbology-ng/qgslinesymbollayerv2.cpp
@@ -649,8 +649,7 @@ double QgsSimpleLineSymbolLayerV2::dxfOffset( const QgsDxfExport& e, QgsSymbolV2
 
 /////////
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 class MyLine
 {

diff --git a/src/gui/effects/qgseffectstackpropertieswidget.cpp b/src/gui/effects/qgseffectstackpropertieswidget.cpp
@@ -29,8 +29,7 @@
 #include <QCheckBox>
 #include <QToolButton>
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 static const int EffectItemType = QStandardItem::UserType + 1;
 

diff --git a/src/gui/layertree/qgscustomlayerorderwidget.cpp b/src/gui/layertree/qgscustomlayerorderwidget.cpp
@@ -91,8 +91,7 @@ void QgsCustomLayerOrderWidget::modelUpdated()
 }
 
 
-///@cond
-/// not part of public API
+///@cond PRIVATE
 
 CustomLayerOrderModel::CustomLayerOrderModel( QgsLayerTreeMapCanvasBridge* bridge, QObject* parent )
     : QAbstractListModel( parent ), mBridge( bridge )

diff --git a/src/gui/layertree/qgscustomlayerorderwidget.h b/src/gui/layertree/qgscustomlayerorderwidget.h
@@ -60,8 +60,7 @@ class GUI_EXPORT QgsCustomLayerOrderWidget : public QWidget
 };
 
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 class CustomLayerOrderModel : public QAbstractListModel
 {
     Q_OBJECT

diff --git a/src/gui/qgsidentifymenu.cpp b/src/gui/qgsidentifymenu.cpp
@@ -22,7 +22,7 @@
 #include "qgshighlight.h"
 
 
-///@cond
+/// @cond PRIVATE
 CustomActionRegistry::CustomActionRegistry( QObject* parent )
     : QgsMapLayerActionRegistry( parent )
 {

diff --git a/src/gui/qgsidentifymenu.h b/src/gui/qgsidentifymenu.h
@@ -23,8 +23,7 @@
 #include "qgsmaptoolidentify.h"
 #include "qgsvectorlayer.h"
 
-// not part of public API
-///@cond
+/// @cond PRIVATE
 //! @note not available in Python bindings
 class CustomActionRegistry : public QgsMapLayerActionRegistry
 {

diff --git a/src/gui/qgsmapmouseevent.cpp b/src/gui/qgsmapmouseevent.cpp
@@ -19,7 +19,7 @@
 
 #include "qgssnappingutils.h"
 
-/// @cond
+/// @cond PRIVATE
 struct EdgesOnlyFilter : public QgsPointLocator::MatchFilter
 {
   bool acceptMatch( const QgsPointLocator::Match& m ) override { return m.hasEdge(); }

diff --git a/src/gui/qgsmapoverviewcanvas.cpp b/src/gui/qgsmapoverviewcanvas.cpp
@@ -268,7 +268,7 @@ QStringList QgsMapOverviewCanvas::layerSet() const
 }
 
 
-///@cond
+/// @cond PRIVATE
 
 QgsPanningWidget::QgsPanningWidget( QWidget* parent )
     : QWidget( parent )

diff --git a/src/gui/qgsmapoverviewcanvas.h b/src/gui/qgsmapoverviewcanvas.h
@@ -116,8 +116,7 @@ class GUI_EXPORT QgsMapOverviewCanvas : public QWidget
 };
 
 
-// not part of public API
-///@cond
+/// @cond PRIVATE
 //! Widget that serves as rectangle showing current extent in overview
 //! @note not available in Python bindings
 class QgsPanningWidget : public QWidget

diff --git a/src/gui/qgsvariableeditorwidget.cpp b/src/gui/qgsvariableeditorwidget.cpp
@@ -242,7 +242,7 @@ void QgsVariableEditorWidget::selectionChanged()
 }
 
 
-/// @cond
+/// @cond PRIVATE
 //
 // VariableEditorTree
 //

diff --git a/src/gui/qgsvariableeditorwidget.h b/src/gui/qgsvariableeditorwidget.h
@@ -138,7 +138,7 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget
 };
 
 
-/// @cond
+/// @cond PRIVATE
 
 /* QgsVariableEditorTree is NOT part of the public QGIS api. It's only
  * public here as Qt meta objects can't be nested classes

diff --git a/src/gui/symbology-ng/qgscategorizedsymbolrendererv2widget.cpp b/src/gui/symbology-ng/qgscategorizedsymbolrendererv2widget.cpp
@@ -40,8 +40,7 @@
 #include <QPainter>
 #include <QFileDialog>
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 QgsCategorizedSymbolRendererV2Model::QgsCategorizedSymbolRendererV2Model( QObject * parent ) : QAbstractItemModel( parent )
     , mRenderer( nullptr )

diff --git a/src/gui/symbology-ng/qgscategorizedsymbolrendererv2widget.h b/src/gui/symbology-ng/qgscategorizedsymbolrendererv2widget.h
@@ -25,8 +25,7 @@ class QgsRendererCategoryV2;
 
 #include "ui_qgscategorizedsymbolrendererv2widget.h"
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 class GUI_EXPORT QgsCategorizedSymbolRendererV2Model : public QAbstractItemModel
 {

diff --git a/src/gui/symbology-ng/qgscptcitycolorrampv2dialog.cpp b/src/gui/symbology-ng/qgscptcitycolorrampv2dialog.cpp
@@ -688,7 +688,7 @@ void QgsCptCityColorRampV2Dialog::refreshModel( const QModelIndex& index )
 }
 #endif
 
-///@cond
+/// @cond PRIVATE
 
 TreeFilterProxyModel::TreeFilterProxyModel( QObject* parent, QgsCptCityBrowserModel* model )
     : QSortFilterProxyModel( parent ), mModel( model )

diff --git a/src/gui/symbology-ng/qgscptcitycolorrampv2dialog.h b/src/gui/symbology-ng/qgscptcitycolorrampv2dialog.h
@@ -83,8 +83,7 @@ class GUI_EXPORT QgsCptCityColorRampV2Dialog : public QDialog, private Ui::QgsCp
 
 };
 
-///@cond
-//not part of public API
+/// @cond PRIVATE
 
 class TreeFilterProxyModel : public QSortFilterProxyModel
 {

diff --git a/src/gui/symbology-ng/qgsgraduatedhistogramwidget.cpp b/src/gui/symbology-ng/qgsgraduatedhistogramwidget.cpp
@@ -180,7 +180,7 @@ void QgsGraduatedHistogramWidget::findClosestRange( double value, int &closestRa
   }
 }
 
-///@cond
+/// @cond PRIVATE
 
 QgsGraduatedHistogramEventFilter::QgsGraduatedHistogramEventFilter( QwtPlot *plot )
     : QObject( plot )

diff --git a/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h b/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h
@@ -87,7 +87,7 @@ class GUI_EXPORT QgsGraduatedHistogramWidget : public QgsHistogramWidget
 // For private use by QgsGraduatedHistogramWidget only,
 // not part of stable api or exposed to Python bindings
 //
-///@cond
+/// @cond PRIVATE
 class GUI_EXPORT QgsGraduatedHistogramEventFilter: public QObject
 {
     Q_OBJECT

diff --git a/src/gui/symbology-ng/qgsgraduatedsymbolrendererv2widget.cpp b/src/gui/symbology-ng/qgsgraduatedsymbolrendererv2widget.cpp
@@ -39,8 +39,7 @@
 
 // ------------------------------ Model ------------------------------------
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 QgsGraduatedSymbolRendererV2Model::QgsGraduatedSymbolRendererV2Model( QObject * parent ) : QAbstractItemModel( parent )
     , mRenderer( nullptr )

diff --git a/src/gui/symbology-ng/qgsgraduatedsymbolrendererv2widget.h b/src/gui/symbology-ng/qgsgraduatedsymbolrendererv2widget.h
@@ -23,8 +23,7 @@
 
 #include "ui_qgsgraduatedsymbolrendererv2widget.h"
 
-///@cond
-//not part of public API
+/// @cond PRIVATE
 
 class GUI_EXPORT QgsGraduatedSymbolRendererV2Model : public QAbstractItemModel
 {

diff --git a/src/gui/symbology-ng/qgssizescalewidget.cpp b/src/gui/symbology-ng/qgssizescalewidget.cpp
@@ -32,8 +32,7 @@
 
 #include <limits>
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 // RAII class to block a QObject signal until destroyed
 struct SignalBlocker

diff --git a/src/gui/symbology-ng/qgssizescalewidget.h b/src/gui/symbology-ng/qgssizescalewidget.h
@@ -67,9 +67,7 @@ class GUI_EXPORT QgsSizeScaleWidget : public QgsDataDefinedAssistant, private Ui
 
 };
 
-
-// not part of public API
-///@cond
+/// @cond PRIVATE
 //! @note not available in Python bindings
 class ItemDelegate : public QItemDelegate
 {

diff --git a/src/gui/symbology-ng/qgssymbollayerv2widget.cpp b/src/gui/symbology-ng/qgssymbollayerv2widget.cpp
@@ -2966,7 +2966,7 @@ void QgsRasterFillSymbolLayerWidget::updatePreviewImage()
 }
 
 
-/// @cond
+/// @cond PRIVATE
 
 QgsSvgListModel::QgsSvgListModel( QObject* parent ) : QAbstractListModel( parent )
 {

diff --git a/src/gui/symbology-ng/qgssymbollayerv2widget.h b/src/gui/symbology-ng/qgssymbollayerv2widget.h
@@ -624,8 +624,7 @@ class GUI_EXPORT QgsCentroidFillSymbolLayerV2Widget : public QgsSymbolLayerV2Wid
 };
 
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 class QgsSvgListModel : public QAbstractListModel
 {

diff --git a/src/gui/symbology-ng/qgssymbollevelsv2dialog.cpp b/src/gui/symbology-ng/qgssymbollevelsv2dialog.cpp
@@ -164,7 +164,7 @@ void QgsSymbolLevelsV2Dialog::setForceOrderingEnabled( bool enabled )
 }
 
 
-///@cond
+/// @cond PRIVATE
 
 QWidget* SpinBoxDelegate::createEditor( QWidget* parent, const QStyleOptionViewItem&, const QModelIndex& ) const
 {

diff --git a/src/gui/symbology-ng/qgssymbollevelsv2dialog.h b/src/gui/symbology-ng/qgssymbollevelsv2dialog.h
@@ -57,8 +57,7 @@ class GUI_EXPORT QgsSymbolLevelsV2Dialog : public QDialog, private Ui::QgsSymbol
     bool mForceOrderingEnabled;
 };
 
-///@cond
-//not part of public API
+///@cond PRIVATE
 
 // delegate used from Qt Spin Box example
 class SpinBoxDelegate : public QItemDelegate

diff --git a/src/gui/symbology-ng/qgssymbolv2selectordialog.cpp b/src/gui/symbology-ng/qgssymbolv2selectordialog.cpp
@@ -44,8 +44,7 @@
 #include <QFile>
 #include <QStandardItem>
 
-///@cond
-//not part of public API
+/// @cond PRIVATE
 
 static const int SymbolLayerItemType = QStandardItem::UserType + 1;
 

diff --git a/src/gui/symbology-ng/qgssymbolv2selectordialog.h b/src/gui/symbology-ng/qgssymbolv2selectordialog.h
@@ -41,8 +41,8 @@ class QgsLineSymbolLayerV2;
 
 class QgsMapCanvas;
 
-///@cond
-//not part of public API
+/// @cond PRIVATE
+
 class DataDefinedRestorer: public QObject
 {
     Q_OBJECT