/*! -> /**

We already have enough doxygen styles to manage!
qgis · Apr 3, 2017 · 06a53e1 · 06a53e1
1 parent 676dc1a
commit 06a53e1
Show file tree

Hide file tree

Showing 21 changed files with 79 additions and 180 deletions.
diff --git a/src/app/pluginmanager/qgspluginmanager.h b/src/app/pluginmanager/qgspluginmanager.h
@@ -39,7 +39,7 @@ const int PLUGMAN_TAB_UPGRADEABLE = 3;
 const int PLUGMAN_TAB_NEW = 4;
 const int PLUGMAN_TAB_INVALID = 5;
 
-/*!
+/**
  * \brief Plugin manager for browsing, (un)installing and (un)loading plugins
 */
 class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManagerBase

diff --git a/src/app/pluginmanager/qgspluginsortfilterproxymodel.h b/src/app/pluginmanager/qgspluginsortfilterproxymodel.h
@@ -35,7 +35,7 @@ const int SPACER_ROLE = Qt::UserRole + 20;  // for sorting
 
 
 
-/*!
+/**
  * \brief Proxy model for filtering and sorting items in Plugin Manager
 */
 class QgsPluginSortFilterProxyModel : public QSortFilterProxyModel

diff --git a/src/app/qgsoptions.h b/src/app/qgsoptions.h
@@ -73,7 +73,8 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
     void on_pbnEditPyramidsOptions_pressed();
     void editGdalDriver( const QString &driverName );
     void saveOptions();
-    /*!
+
+    /**
     * Slot to reset any temporarily applied options on dialog close/cancel */
     void rejectOptions();
     //! Slot to change the theme this is handled when the user

diff --git a/src/app/qgsprojectproperties.cpp b/src/app/qgsprojectproperties.cpp
@@ -1281,23 +1281,14 @@ void QgsProjectProperties::srIdUpdated()
   }
 }
 
-/*!
- * Function to save non-base dialog states
- */
 void QgsProjectProperties::saveState()
 {
 }
 
-/*!
- * Function to restore non-base dialog states
- */
 void QgsProjectProperties::restoreState()
 {
 }
 
-/*!
- * Set WMS default extent to current canvas extent
- */
 void QgsProjectProperties::on_pbnWMSExtCanvas_clicked()
 {
   QgsRectangle ext = mMapCanvas->extent();

diff --git a/src/app/qgsprojectproperties.h b/src/app/qgsprojectproperties.h
@@ -47,7 +47,7 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
 
     ~QgsProjectProperties();
 
-    /*!
+    /**
        Every project has a title
      */
     QString title() const;
@@ -57,12 +57,13 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
     QString projectionWkt();
 
   public slots:
-    /*!
+
+    /**
      * Slot called when apply button is pressed or dialog is accepted
      */
     void apply();
 
-    /*!
+    /**
      * Slot to show the projections tab when the dialog is opened
      */
     void showProjectionsTab();
@@ -84,8 +85,8 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
     //! A scale in the list of project scales changed
     void scaleItemChanged( QListWidgetItem *changedScaleItem );
 
-    /*!
-     * Slots for WMS project settings
+    /**
+     * Set WMS default extent to current canvas extent
      */
     void on_pbnWMSExtCanvas_clicked();
     void on_pbnWMSAddSRS_clicked();
@@ -98,24 +99,24 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
     void on_mWMSInspireScenario1_toggled( bool on );
     void on_mWMSInspireScenario2_toggled( bool on );
 
-    /*!
+    /**
      * Slots to select/deselect all the WFS layers
      */
     void on_pbnWFSLayersSelectAll_clicked();
     void on_pbnWFSLayersDeselectAll_clicked();
 
-    /*!
+    /**
      * Slots to select/deselect all the WCS layers
      */
     void on_pbnWCSLayersSelectAll_clicked();
     void on_pbnWCSLayersDeselectAll_clicked();
 
-    /*!
+    /**
      * Slots to launch OWS test
      */
     void on_pbnLaunchOWSChecker_clicked();
 
-    /*!
+    /**
      * Slots for Styles
      */
     void on_pbtnStyleManager_clicked();
@@ -126,22 +127,22 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
     void on_mTransparencySlider_valueChanged( int value );
     void on_mTransparencySpinBox_valueChanged( int value );
 
-    /*!
+    /**
      * Slot to show the context help for this dialog
      */
     void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "introduction/qgis_configuration.html#project-properties" ) ); }
 
-    /*!
+    /**
      * Slot to link WFS checkboxes
      */
     void cbxWFSPubliedStateChanged( int aIdx );
 
-    /*!
+    /**
      * Slot to link WCS checkboxes
      */
     void cbxWCSPubliedStateChanged( int aIdx );
 
-    /*!
+    /**
       * If user changes the CRS, set the corresponding map units
       */
     void srIdUpdated();
@@ -180,17 +181,17 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
     void populateStyles();
     void editSymbol( QComboBox *cbo );
 
-    /*!
+    /**
      * Function to save non-base dialog states
      */
     void saveState();
 
-    /*!
+    /**
      * Function to restore non-base dialog states
      */
     void restoreState();
 
-    /*!
+    /**
      * Reset the Python macros
      */
     void resetPythonMacros();

diff --git a/src/core/qgsapplication.cpp b/src/core/qgsapplication.cpp
@@ -104,19 +104,6 @@ const char *QgsApplication::QGIS_APPLICATION_NAME = "QGIS3";
 
 QgsApplication::ApplicationMembers *QgsApplication::sApplicationMembers = nullptr;
 
-/*!
-  \class QgsApplication
-  \brief The QgsApplication class manages application-wide information.
-
-  This is a subclass of QApplication and should be instantiated in place of
-  QApplication. Most methods are static in keeping with the design of QApplication.
-
-  This class hides platform-specific path information and provides
-  a portable way of referencing specific files and directories.
-  Ideally, hard-coded paths should appear only here and not in other modules
-  so that platform-conditional code is minimized and paths are easier
-  to change due to centralization.
-*/
 QgsApplication::QgsApplication( int &argc, char **argv, bool GUIenabled, const QString &customConfigPath, const QString &platformName )
   : QApplication( argc, argv, GUIenabled )
 {
@@ -489,16 +476,11 @@ QPixmap QgsApplication::getThemePixmap( const QString &name )
   }
 }
 
-/*!
-  Set the theme path to the specified theme.
-*/
 void QgsApplication::setThemeName( const QString &themeName )
 {
   ABISYM( mThemeName ) = themeName;
 }
-/*!
- * Get the active theme name
- */
+
 QString QgsApplication::themeName()
 {
   return ABISYM( mThemeName );
@@ -583,16 +565,11 @@ QHash<QString, QString> QgsApplication::uiThemes()
   return mapping;
 }
 
-/*!
-  Returns the path to the authors file.
-*/
 QString QgsApplication::authorsFilePath()
 {
   return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/AUTHORS" );
 }
-/*!
-  Returns the path to the contributors file.
-*/
+
 QString QgsApplication::contributorsFilePath()
 {
   return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/CONTRIBUTORS" );
@@ -602,17 +579,11 @@ QString QgsApplication::developersMapFilePath()
   return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/developersmap.html" );
 }
 
-/*!
-  Returns the path to the sponsors file.
-*/
 QString QgsApplication::sponsorsFilePath()
 {
   return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/SPONSORS" );
 }
 
-/*!
-  Returns the path to the donors file.
-*/
 QString QgsApplication::donorsFilePath()
 {
   return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/DONORS" );
@@ -704,9 +675,6 @@ QString QgsApplication::srsDatabaseFilePath()
   }
 }
 
-/*!
-  Returns the paths to the svg directories.
-*/
 QStringList QgsApplication::svgPaths()
 {
   //local directories to search when looking for an SVG with a given basename
@@ -730,9 +698,6 @@ QStringList QgsApplication::svgPaths()
   return paths;
 }
 
-/*!
-  Returns the paths to the composer template directories.
-*/
 QStringList QgsApplication::composerTemplatePaths()
 {
   //local directories to search when looking for an SVG with a given basename

diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h
@@ -43,6 +43,15 @@ class QgsAnnotationRegistry;
 /** \ingroup core
  * Extends QApplication to provide access to QGIS specific resources such
  * as theme paths, database paths etc.
+ *
+ * This is a subclass of QApplication and should be instantiated in place of
+  QApplication. Most methods are static in keeping with the design of QApplication.
+
+  This class hides platform-specific path information and provides
+  a portable way of referencing specific files and directories.
+  Ideally, hard-coded paths should appear only here and not in other modules
+  so that platform-conditional code is minimized and paths are easier
+  to change due to centralization.
  */
 
 class CORE_EXPORT QgsApplication : public QApplication
@@ -142,7 +151,7 @@ class CORE_EXPORT QgsApplication : public QApplication
      */
     static QString translatorsFilePath();
 
-    /*!
+    /**
       Returns the path to the licence file.
      */
     static QString licenceFilePath();

diff --git a/src/core/qgscoordinatereferencesystem.h b/src/core/qgscoordinatereferencesystem.h
@@ -204,7 +204,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
 
     ~QgsCoordinateReferenceSystem();
 
-    /*!
+    /**
      * Constructs a CRS object from a string definition using createFromString()
      *
      * It supports the following formats:

diff --git a/src/core/qgscoordinatetransform.h b/src/core/qgscoordinatetransform.h
@@ -74,22 +74,22 @@ class CORE_EXPORT QgsCoordinateTransform
 
     ~QgsCoordinateTransform();
 
-    /*!
+    /**
      * Returns true if the coordinate transform is valid, ie both the source and destination
      * CRS have been set and are valid.
      * \since QGIS 3.0
      */
     bool isValid() const;
 
-    /*!
+    /**
      * Sets the source coordinate reference system.
      * \param crs CRS to transform coordinates from
      * \see sourceCrs()
      * \see setDestinationCrs()
      */
     void setSourceCrs( const QgsCoordinateReferenceSystem &crs );
 
-    /*!
+    /**
      * Sets the destination coordinate reference system.
      * \param crs CRS to transform coordinates to
      * \see destinationCrs()

diff --git a/src/gui/attributetable/qgsfeaturelistview.cpp b/src/gui/attributetable/qgsfeaturelistview.cpp
@@ -219,12 +219,6 @@ void QgsFeatureListView::repaintRequested()
   setDirtyRegion( viewport()->rect() );
 }
 
-/*!
-    This function is called with the given \a event when a mouse move event is
-    sent to the widget. If a selection is in progress and new items are moved
-    over the selection is extended; if a drag is in progress it is continued.
-*/
-
 void QgsFeatureListView::mouseMoveEvent( QMouseEvent *event )
 {
   QPoint pos = event->pos();
@@ -241,13 +235,6 @@ void QgsFeatureListView::mouseMoveEvent( QMouseEvent *event )
   }
 }
 
-/*!
-    This function is called with the given \a event when a mouse button is released,
-    after a mouse press event on the widget. If a user presses the mouse inside your
-    widget and then drags the mouse to another location before releasing the mouse button,
-    your widget receives the release event. The function will emit the clicked() signal if an
-    item was being pressed.
-*/
 void QgsFeatureListView::mouseReleaseEvent( QMouseEvent *event )
 {
   Q_UNUSED( event );

diff --git a/src/gui/qgisgui.h b/src/gui/qgisgui.h
@@ -31,7 +31,7 @@ class QFont;
 namespace QgisGui
 {
 
-  /*!
+  /**
    * /var ModalDialogFlags
    * /brief Flags used to create a modal dialog (adapted from QMessageBox).
    *

diff --git a/src/gui/qgsconfigureshortcutsdialog.cpp b/src/gui/qgsconfigureshortcutsdialog.cpp
@@ -59,18 +59,12 @@ QgsConfigureShortcutsDialog::~QgsConfigureShortcutsDialog()
   saveState();
 }
 
-/*!
- * Function to save dialog window state
- */
 void QgsConfigureShortcutsDialog::saveState()
 {
   QgsSettings settings;
   settings.setValue( QStringLiteral( "Windows/ShortcutsDialog/geometry" ), saveGeometry() );
 }
 
-/*!
- * Function to restore dialog window state
- */
 void QgsConfigureShortcutsDialog::restoreState()
 {
   QgsSettings settings;