Docstring updates

manisandro · manisandro · commit cdbd4e45d4a8 · 2016-05-29T21:18:57.000+02:00
diff --git a/python/core/qgsbillboardregistry.sip b/python/core/qgsbillboardregistry.sip
@@ -38,6 +38,11 @@ class QgsBillBoardRegistry : public QObject
      * @param parent The parent
      */
     void removeItem( void* parent );
+
+    /**
+     * @brief Retreive all registered billboard items
+     * @return List of registered billboard items
+     */
     QList<QgsBillBoardItem*> items() const;
 
   signals:
diff --git a/python/core/qgsplugininterface.sip b/python/core/qgsplugininterface.sip
@@ -13,13 +13,16 @@
  *                                                                         *
  ***************************************************************************/
 
+/**
+ * @brief Trivial base class for plugin interfaces
+ */
 class QgsPluginInterface : QObject
 {
 %TypeHeaderCode
 #include "qgsplugininterface.h"
 %End
 
-  // Should only be instantiated from subclasses
-  private:
+  protected:
+    /** Should only be instantiated from subclasses */
     QgsPluginInterface( QObject* parent = 0 );
 };
diff --git a/python/gui/qgsmaplayerpropertiesfactory.sip b/python/gui/qgsmaplayerpropertiesfactory.sip
@@ -8,8 +8,25 @@ class QgsMapLayerPropertiesFactory
 %End
 
   public:
+    /** Constructor */
     QgsMapLayerPropertiesFactory();
 
+    /** Destructor */
+    virtual ~QgsMapLayerPropertiesFactory();
+
+    /**
+     * @brief Create a new properties page
+     * @param layer The layer for which to create the page
+     * @param parent The parent widget
+     * @return The new properties page instance
+     */
     virtual QgsVectorLayerPropertiesPage* createVectorLayerPropertiesPage( QgsVectorLayer* layer, QWidget* parent ) = 0;
+
+    /**
+     * @brief Creates the QListWidgetItem for the properties page
+     * @param layer The layer for which to create the item
+     * @param view The parent QListView
+     * @return The QListWidgetItem for the properties page
+     */
     virtual QListWidgetItem* createVectorLayerPropertiesItem( QgsVectorLayer* layer, QListWidget* view ) = 0;
 };
diff --git a/python/gui/qgsvectorlayerpropertiespage.sip b/python/gui/qgsvectorlayerpropertiespage.sip
@@ -1,15 +1,21 @@
 /** \ingroup gui
  * \note added in 2.1
  */
+
+/**
+ * @brief Base class for custom vector layer property pages
+ */
 class QgsVectorLayerPropertiesPage : QWidget
 {
 %TypeHeaderCode
 #include <qgsvectorlayerpropertiespage.h>
 %End
 
   public:
+    /** Constructor */
     explicit QgsVectorLayerPropertiesPage( QWidget *parent = 0 );
 
   public slots:
+    /** Apply changes */
     virtual void apply() = 0;
 };
diff --git a/src/core/qgsbillboardregistry.h b/src/core/qgsbillboardregistry.h
@@ -59,6 +59,11 @@ class CORE_EXPORT QgsBillBoardRegistry : public QObject
      * @param parent The parent
      */
     void removeItem( void* parent );
+
+    /**
+     * @brief Retreive all registered billboard items
+     * @return List of registered billboard items
+     */
     QList<QgsBillBoardItem*> items() const;
 
   signals:
diff --git a/src/core/qgsplugininterface.h b/src/core/qgsplugininterface.h
@@ -18,11 +18,15 @@
 
 #include <QObject>
 
+/**
+ * @brief Trivial base class for plugin interfaces
+ */
 class CORE_EXPORT QgsPluginInterface : public QObject
 {
     Q_OBJECT
 
-  public:
+  protected:
+    /** Should only be instantiated from subclasses */
     QgsPluginInterface( QObject* parent = 0 ) : QObject( parent ) {}
 };
 
diff --git a/src/gui/qgsmaplayerpropertiesfactory.cpp b/src/gui/qgsmaplayerpropertiesfactory.cpp
@@ -18,3 +18,7 @@
 QgsMapLayerPropertiesFactory::QgsMapLayerPropertiesFactory()
 {
 }
+
+QgsMapLayerPropertiesFactory::~QgsMapLayerPropertiesFactory()
+{
+}
diff --git a/src/gui/qgsmaplayerpropertiesfactory.h b/src/gui/qgsmaplayerpropertiesfactory.h
@@ -20,12 +20,32 @@
 
 #include "qgsvectorlayerpropertiespage.h"
 
+/**
+ * @brief Factory class for creating custom map layer property pages
+ */
 class GUI_EXPORT QgsMapLayerPropertiesFactory
 {
   public:
+    /** Constructor */
     QgsMapLayerPropertiesFactory();
 
+    /** Destructor */
+    virtual ~QgsMapLayerPropertiesFactory();
+
+    /**
+     * @brief Create a new properties page
+     * @param layer The layer for which to create the page
+     * @param parent The parent widget
+     * @return The new properties page instance
+     */
     virtual QgsVectorLayerPropertiesPage* createVectorLayerPropertiesPage( QgsVectorLayer* layer, QWidget* parent ) = 0;
+
+    /**
+     * @brief Creates the QListWidgetItem for the properties page
+     * @param layer The layer for which to create the item
+     * @param view The parent QListView
+     * @return The QListWidgetItem for the properties page
+     */
     virtual QListWidgetItem* createVectorLayerPropertiesItem( QgsVectorLayer* layer, QListWidget* view ) = 0;
 };
 
diff --git a/src/gui/qgsvectorlayerpropertiespage.h b/src/gui/qgsvectorlayerpropertiespage.h
@@ -20,15 +20,18 @@
 
 class QgsVectorLayer;
 
+/**
+ * @brief Base class for custom vector layer property pages
+ */
 class GUI_EXPORT QgsVectorLayerPropertiesPage : public QWidget
 {
     Q_OBJECT
   public:
+    /** Constructor */
     explicit QgsVectorLayerPropertiesPage( QWidget *parent = 0 );
 
-  signals:
-
   public slots:
+    /** Apply changes */
     virtual void apply() = 0;
 };
 

Original file line number	Diff line number	Diff line change
`@@ -18,3 +18,7 @@`
`18`	`18`	`QgsMapLayerPropertiesFactory::QgsMapLayerPropertiesFactory()`
`19`	`19`	`{`
`20`	`20`	`}`
	`21`	`+`
	`22`	`+QgsMapLayerPropertiesFactory::~QgsMapLayerPropertiesFactory()`
	`23`	`+{`
	`24`	`+}`