Skip to content

Commit

Permalink
[doxygen] remove useless @brief
Browse files Browse the repository at this point in the history
  • Loading branch information
3nids committed Dec 6, 2017
1 parent f29306d commit 906259b
Show file tree
Hide file tree
Showing 11 changed files with 9 additions and 11 deletions.
1 change: 0 additions & 1 deletion python/core/qgsvectorlayerlabeling.sip
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ Try to create instance of an implementation based on the XML data
virtual void writeTextSymbolizer( QDomNode &parent, QgsPalLayerSettings &settings, const QgsStringMap &props ) const;
%Docstring
Writes a TextSymbolizer element contents based on the provided labeling settings
writeTextSymbolizer
\param parent the node that will have the text symbolizer element added to it
\param settings the settings getting translated to a TextSymbolizer
\param props a open ended set of properties that can drive/inform the SLD encoding
Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgsdial.sip
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class QgsDial : QDial

QgsDial( QWidget *parent /TransferThis/ = 0 );
%Docstring
QgsDial constructor for QgsDial
Constructor for QgsDial
\param parent parent object
%End

Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgsencodingfiledialog.sip
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class QgsEncodingFileDialog: QFileDialog
const QString &caption = QString(), const QString &directory = QString(),
const QString &filter = QString(), const QString &encoding = QString() );
%Docstring
QgsEncodingFileDialog constructor for QgsEncodingFileDialog
Constructor for QgsEncodingFileDialog
%End
QString encoding() const;
%Docstring
Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgserrordialog.sip
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class QgsErrorDialog: QDialog

QgsErrorDialog( const QgsError &error, const QString &title, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
%Docstring
QgsErrorDialog constructor for QgsErrorDialog
Constructor for QgsErrorDialog
%End

static void show( const QgsError &error, const QString &title, QWidget *parent = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
Expand Down
1 change: 0 additions & 1 deletion src/core/qgsvectorlayerlabeling.h
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ class CORE_EXPORT QgsAbstractVectorLayerLabeling

/**
* Writes a TextSymbolizer element contents based on the provided labeling settings
* @brief writeTextSymbolizer
* \param parent the node that will have the text symbolizer element added to it
* \param settings the settings getting translated to a TextSymbolizer
* \param props a open ended set of properties that can drive/inform the SLD encoding
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsdatasourcemanagerdialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class GUI_EXPORT QgsDataSourceManagerDialog : public QgsOptionsDialogBase, priva
~QgsDataSourceManagerDialog();

/**
* @brief openPage open a given page in the dialog
* Open a given page in the dialog
* \param pageName the page name, usually the provider name or "browser" (for the browser panel)
* or "ogr" (vector layers) or "raster" (raster layers)
*/
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsdial.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class GUI_EXPORT QgsDial : public QDial
public:

/**
* @brief QgsDial constructor for QgsDial
* Constructor for QgsDial
* \param parent parent object
*/
QgsDial( QWidget *parent SIP_TRANSFERTHIS = nullptr );
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsencodingfiledialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class GUI_EXPORT QgsEncodingFileDialog: public QFileDialog
public:

/**
* @brief QgsEncodingFileDialog constructor for QgsEncodingFileDialog
* Constructor for QgsEncodingFileDialog
*/
QgsEncodingFileDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr,
const QString &caption = QString(), const QString &directory = QString(),
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgserrordialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class GUI_EXPORT QgsErrorDialog: public QDialog, private Ui::QgsErrorDialogBase
public:

/**
* @brief QgsErrorDialog constructor for QgsErrorDialog
* Constructor for QgsErrorDialog
*/
QgsErrorDialog( const QgsError &error, const QString &title, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );

Expand Down
2 changes: 1 addition & 1 deletion src/providers/ogr/qgsogrdbsourceselect.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
#include "qgsogrdbtablemodel.h"

/**
* @brief The QgsOgrDbSourceSelect class is a generic class for DB based OGR
* The QgsOgrDbSourceSelect class is a generic class for DB based OGR
* source selects.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion src/server/services/wms/qgswmsparameters.h
Original file line number Diff line number Diff line change
Expand Up @@ -912,7 +912,7 @@ namespace QgsWms
QgsWmsParametersComposerMap composerMapParameters( int mapId ) const;

/**
* @brief externalWMSUri
* Return the external WMS uri
* \param id the id of the external wms
* @return uri string or an empty string if the external wms id does not exist
*/
Expand Down

0 comments on commit 906259b

Please sign in to comment.