[doxygen] remove useless @brief

qgis · Dec 6, 2017 · 906259b · 906259b
1 parent f29306d
commit 906259b
Show file tree

Hide file tree

Showing 11 changed files with 9 additions and 11 deletions.
diff --git a/python/core/qgsvectorlayerlabeling.sip b/python/core/qgsvectorlayerlabeling.sip
@@ -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

diff --git a/python/gui/qgsdial.sip b/python/gui/qgsdial.sip
@@ -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
 

diff --git a/python/gui/qgsencodingfiledialog.sip b/python/gui/qgsencodingfiledialog.sip
@@ -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

diff --git a/python/gui/qgserrordialog.sip b/python/gui/qgserrordialog.sip
@@ -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 );

diff --git a/src/core/qgsvectorlayerlabeling.h b/src/core/qgsvectorlayerlabeling.h
@@ -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

diff --git a/src/gui/qgsdatasourcemanagerdialog.h b/src/gui/qgsdatasourcemanagerdialog.h
@@ -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)
      */

diff --git a/src/gui/qgsdial.h b/src/gui/qgsdial.h
@@ -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 );

diff --git a/src/gui/qgsencodingfiledialog.h b/src/gui/qgsencodingfiledialog.h
@@ -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(),

diff --git a/src/gui/qgserrordialog.h b/src/gui/qgserrordialog.h
@@ -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 );
 

diff --git a/src/providers/ogr/qgsogrdbsourceselect.h b/src/providers/ogr/qgsogrdbsourceselect.h
@@ -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.
  *
  */

diff --git a/src/server/services/wms/qgswmsparameters.h b/src/server/services/wms/qgswmsparameters.h
@@ -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
        */