fix doxymentation

qgis · Jul 24, 2017 · 33071f4 · 33071f4
1 parent fcc0d7d
commit 33071f4
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 3 deletions.
diff --git a/python/core/qgsdatumtransformstore.sip b/python/core/qgsdatumtransformstore.sip
@@ -41,6 +41,7 @@ class QgsDatumTransformStore
  Will return transform from layer's CRS to current destination CRS.
  :return: transformation associated with layer, or an invalid QgsCoordinateTransform
  if no transform is associated with the layer
+ \param layer the associated layer
  \param srcAuthId source CRS (defaults to layer crs)
  \param dstAuthId destination CRS (defaults to store's crs)
  :rtype: QgsCoordinateTransform

diff --git a/python/core/qgsuserprofilemanager.sip b/python/core/qgsuserprofilemanager.sip
@@ -53,6 +53,7 @@ class QgsUserProfileManager : QObject
    Returns a new QgsUserProfile. Ownership transferred to caller.
  \param defaultProfile The profile name to find. Empty profile name will return "default" for the name.
  \param createNew Create the profile folder if it doesn't exist.
+ \param initSettings if the settings should be initialized
  :return: The user profile
  :rtype: QgsUserProfile
 %End

diff --git a/python/gui/qgsattributeform.sip b/python/gui/qgsattributeform.sip
@@ -173,6 +173,7 @@ class QgsAttributeForm : QWidget
 
  \param field The field to change
  \param value The new value
+ \param hintText A hint text for non existent joined features
 %End
 
     void setFeature( const QgsFeature &feature );

diff --git a/src/core/qgsdatumtransformstore.h b/src/core/qgsdatumtransformstore.h
@@ -47,6 +47,7 @@ class CORE_EXPORT QgsDatumTransformStore
      * Will return transform from layer's CRS to current destination CRS.
      * \returns transformation associated with layer, or an invalid QgsCoordinateTransform
      * if no transform is associated with the layer
+     * \param layer the associated layer
      * \param srcAuthId source CRS (defaults to layer crs)
      * \param dstAuthId destination CRS (defaults to store's crs)
      */

diff --git a/src/core/qgsuserprofilemanager.h b/src/core/qgsuserprofilemanager.h
@@ -63,6 +63,7 @@ class CORE_EXPORT QgsUserProfileManager : public QObject
      * \note Returns a new QgsUserProfile. Ownership transferred to caller.
      * \param defaultProfile The profile name to find. Empty profile name will return "default" for the name.
      * \param createNew Create the profile folder if it doesn't exist.
+     * \param initSettings if the settings should be initialized
      * \return The user profile
      */
     QgsUserProfile *getProfile( const QString &defaultProfile = "default", bool createNew = true, bool initSettings = true ) SIP_FACTORY;

diff --git a/src/gui/qgsattributeform.h b/src/gui/qgsattributeform.h
@@ -208,6 +208,7 @@ class GUI_EXPORT QgsAttributeForm : public QWidget
      *
      * \param field The field to change
      * \param value The new value
+     * \param hintText A hint text for non existent joined features
      */
     void changeAttribute( const QString &field, const QVariant &value, const QString &hintText = QString() );
 

diff --git a/src/gui/qgsdatasourcemanagerdialog.h b/src/gui/qgsdatasourcemanagerdialog.h
@@ -48,15 +48,16 @@ class GUI_EXPORT QgsDataSourceManagerDialog : public QgsOptionsDialogBase, priva
   public:
 
     /** QgsDataSourceManagerDialog constructor
-      * @param parent the object
-      * @param fl window flags
+      * \param parent the object
+      * \param canvas a pointer to the map canvas
+      * \param fl window flags
       */
     explicit QgsDataSourceManagerDialog( QWidget *parent = nullptr, QgsMapCanvas *canvas = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
     ~QgsDataSourceManagerDialog();
 
     /**
      * @brief openPage open a given page in the dialog
-     * @param pageName the page name, usually the provider name or "browser" (for the browser panel)
+     * \param pageName the page name, usually the provider name or "browser" (for the browser panel)
      *        or "ogr" (vector layers) or "raster" (raster layers)
      */
     void openPage( QString pageName );