Skip to content

Commit

Permalink
Try to fix doxygen errors/warnings on Debian nightlies
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Jan 10, 2016
1 parent 651ca51 commit 17793c3
Show file tree
Hide file tree
Showing 38 changed files with 41 additions and 62 deletions.
3 changes: 1 addition & 2 deletions src/core/geometry/qgsgeos.cpp
Expand Up @@ -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, ... )
{
Expand Down
2 changes: 1 addition & 1 deletion src/core/geometry/qgsgeos.h
Expand Up @@ -152,7 +152,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
static int geomDigits( const GEOSGeometry* geom );
};

/// @cond
/// @cond PRIVATE

class GEOSException
{
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsdatadefined_p.h
Expand Up @@ -15,7 +15,7 @@
#ifndef QGSDATADEFINED_PRIVATE_H
#define QGSDATADEFINED_PRIVATE_H

/// @cond
/// @cond PRIVATE

//
// W A R N I N G
Expand Down
6 changes: 2 additions & 4 deletions src/core/qgsexpressioncontext.cpp
Expand Up @@ -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:
Expand Down Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsfeature_p.h
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsfeatureiterator.cpp
Expand Up @@ -21,7 +21,7 @@
#include <algorithm>


/// @cond
/// @cond PRIVATE
class QgsExpressionSorter
{
public:
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgsfield_p.h
Expand Up @@ -16,7 +16,7 @@
#ifndef QGSFIELD_PRIVATE_H
#define QGSFIELD_PRIVATE_H

/// @cond
/// @cond PRIVATE

//
// W A R N I N G
Expand Down
3 changes: 1 addition & 2 deletions src/core/qgsnetworkaccessmanager.cpp
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgswebframe.h
Expand Up @@ -30,7 +30,7 @@
*/
class CORE_EXPORT QWebFrame : public QObject
{
/// @cond
/// @cond NOT_STABLE_API
Q_OBJECT

public:
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgswebpage.h
Expand Up @@ -35,7 +35,7 @@
*/
class CORE_EXPORT QWebSettings : public QObject
{
/// @cond
/// @cond NOT_STABLE_API
Q_OBJECT

public:
Expand Down Expand Up @@ -98,7 +98,7 @@ class CORE_EXPORT QWebSettings : public QObject
*/
class CORE_EXPORT QWebPage : public QObject
{
/// @cond
/// @cond NOT_STABLE_API
Q_OBJECT

public:
Expand Down
2 changes: 1 addition & 1 deletion src/core/qgswebview.h
Expand Up @@ -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 )
Expand Down
3 changes: 1 addition & 2 deletions src/core/symbology-ng/qgslinesymbollayerv2.cpp
Expand Up @@ -649,8 +649,7 @@ double QgsSimpleLineSymbolLayerV2::dxfOffset( const QgsDxfExport& e, QgsSymbolV2

/////////

///@cond
//not part of public API
///@cond PRIVATE

class MyLine
{
Expand Down
3 changes: 1 addition & 2 deletions src/gui/effects/qgseffectstackpropertieswidget.cpp
Expand Up @@ -29,8 +29,7 @@
#include <QCheckBox>
#include <QToolButton>

///@cond
//not part of public API
///@cond PRIVATE

static const int EffectItemType = QStandardItem::UserType + 1;

Expand Down
3 changes: 1 addition & 2 deletions src/gui/layertree/qgscustomlayerorderwidget.cpp
Expand Up @@ -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 )
Expand Down
3 changes: 1 addition & 2 deletions src/gui/layertree/qgscustomlayerorderwidget.h
Expand Up @@ -60,8 +60,7 @@ class GUI_EXPORT QgsCustomLayerOrderWidget : public QWidget
};


///@cond
//not part of public API
///@cond PRIVATE
class CustomLayerOrderModel : public QAbstractListModel
{
Q_OBJECT
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsidentifymenu.cpp
Expand Up @@ -22,7 +22,7 @@
#include "qgshighlight.h"


///@cond
/// @cond PRIVATE
CustomActionRegistry::CustomActionRegistry( QObject* parent )
: QgsMapLayerActionRegistry( parent )
{
Expand Down
3 changes: 1 addition & 2 deletions src/gui/qgsidentifymenu.h
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsmapmouseevent.cpp
Expand Up @@ -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(); }
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsmapoverviewcanvas.cpp
Expand Up @@ -268,7 +268,7 @@ QStringList QgsMapOverviewCanvas::layerSet() const
}


///@cond
/// @cond PRIVATE

QgsPanningWidget::QgsPanningWidget( QWidget* parent )
: QWidget( parent )
Expand Down
3 changes: 1 addition & 2 deletions src/gui/qgsmapoverviewcanvas.h
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsvariableeditorwidget.cpp
Expand Up @@ -242,7 +242,7 @@ void QgsVariableEditorWidget::selectionChanged()
}


/// @cond
/// @cond PRIVATE
//
// VariableEditorTree
//
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsvariableeditorwidget.h
Expand Up @@ -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
Expand Down
Expand Up @@ -40,8 +40,7 @@
#include <QPainter>
#include <QFileDialog>

///@cond
//not part of public API
///@cond PRIVATE

QgsCategorizedSymbolRendererV2Model::QgsCategorizedSymbolRendererV2Model( QObject * parent ) : QAbstractItemModel( parent )
, mRenderer( nullptr )
Expand Down
3 changes: 1 addition & 2 deletions src/gui/symbology-ng/qgscategorizedsymbolrendererv2widget.h
Expand Up @@ -25,8 +25,7 @@ class QgsRendererCategoryV2;

#include "ui_qgscategorizedsymbolrendererv2widget.h"

///@cond
//not part of public API
///@cond PRIVATE

class GUI_EXPORT QgsCategorizedSymbolRendererV2Model : public QAbstractItemModel
{
Expand Down
2 changes: 1 addition & 1 deletion src/gui/symbology-ng/qgscptcitycolorrampv2dialog.cpp
Expand Up @@ -688,7 +688,7 @@ void QgsCptCityColorRampV2Dialog::refreshModel( const QModelIndex& index )
}
#endif

///@cond
/// @cond PRIVATE

TreeFilterProxyModel::TreeFilterProxyModel( QObject* parent, QgsCptCityBrowserModel* model )
: QSortFilterProxyModel( parent ), mModel( model )
Expand Down
3 changes: 1 addition & 2 deletions src/gui/symbology-ng/qgscptcitycolorrampv2dialog.h
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/gui/symbology-ng/qgsgraduatedhistogramwidget.cpp
Expand Up @@ -180,7 +180,7 @@ void QgsGraduatedHistogramWidget::findClosestRange( double value, int &closestRa
}
}

///@cond
/// @cond PRIVATE

QgsGraduatedHistogramEventFilter::QgsGraduatedHistogramEventFilter( QwtPlot *plot )
: QObject( plot )
Expand Down
2 changes: 1 addition & 1 deletion src/gui/symbology-ng/qgsgraduatedhistogramwidget.h
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions src/gui/symbology-ng/qgsgraduatedsymbolrendererv2widget.cpp
Expand Up @@ -39,8 +39,7 @@

// ------------------------------ Model ------------------------------------

///@cond
//not part of public API
///@cond PRIVATE

QgsGraduatedSymbolRendererV2Model::QgsGraduatedSymbolRendererV2Model( QObject * parent ) : QAbstractItemModel( parent )
, mRenderer( nullptr )
Expand Down
3 changes: 1 addition & 2 deletions src/gui/symbology-ng/qgsgraduatedsymbolrendererv2widget.h
Expand Up @@ -23,8 +23,7 @@

#include "ui_qgsgraduatedsymbolrendererv2widget.h"

///@cond
//not part of public API
/// @cond PRIVATE

class GUI_EXPORT QgsGraduatedSymbolRendererV2Model : public QAbstractItemModel
{
Expand Down
3 changes: 1 addition & 2 deletions src/gui/symbology-ng/qgssizescalewidget.cpp
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions src/gui/symbology-ng/qgssizescalewidget.h
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/gui/symbology-ng/qgssymbollayerv2widget.cpp
Expand Up @@ -2966,7 +2966,7 @@ void QgsRasterFillSymbolLayerWidget::updatePreviewImage()
}


/// @cond
/// @cond PRIVATE

QgsSvgListModel::QgsSvgListModel( QObject* parent ) : QAbstractListModel( parent )
{
Expand Down
3 changes: 1 addition & 2 deletions src/gui/symbology-ng/qgssymbollayerv2widget.h
Expand Up @@ -624,8 +624,7 @@ class GUI_EXPORT QgsCentroidFillSymbolLayerV2Widget : public QgsSymbolLayerV2Wid
};


///@cond
//not part of public API
///@cond PRIVATE

class QgsSvgListModel : public QAbstractListModel
{
Expand Down
2 changes: 1 addition & 1 deletion src/gui/symbology-ng/qgssymbollevelsv2dialog.cpp
Expand Up @@ -164,7 +164,7 @@ void QgsSymbolLevelsV2Dialog::setForceOrderingEnabled( bool enabled )
}


///@cond
/// @cond PRIVATE

QWidget* SpinBoxDelegate::createEditor( QWidget* parent, const QStyleOptionViewItem&, const QModelIndex& ) const
{
Expand Down
3 changes: 1 addition & 2 deletions src/gui/symbology-ng/qgssymbollevelsv2dialog.h