Add missing docs

qgis · Jan 30, 2017 · 1c1dae3 · 1c1dae3
1 parent 41fe335
commit 1c1dae3
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/src/core/annotations/qgsannotation.h b/src/core/annotations/qgsannotation.h
@@ -265,6 +265,10 @@ class CORE_EXPORT QgsAnnotation : public QObject
 
   protected:
 
+    /**
+     * Renders the annotation's contents to a target /a context at the specified /a size.
+     * Derived classes should implement their custom annotation drawing logic here.
+     */
     virtual void renderAnnotation( QgsRenderContext& context, QSizeF size ) const = 0;
 
     /**

diff --git a/src/core/annotations/qgsannotationmanager.h b/src/core/annotations/qgsannotationmanager.h
@@ -23,6 +23,20 @@
 class QgsProject;
 class QgsAnnotation;
 
+
+/** \ingroup core
+ * \class QgsAnnotationManager
+ * \note added in QGIS 3.0
+ *
+ * \brief Manages storage of a set of QgsAnnotation annotation objects.
+ *
+ * QgsAnnotationManager handles the storage, serializing and deserializing
+ * of QgsAnnotations. Usually this class is not constructed directly, but
+ * rather accessed through a QgsProject via QgsProject::annotationManager().
+ *
+ * QgsAnnotationManager retains ownership of all the annotations contained
+ * in the manager.
+ */
 class CORE_EXPORT QgsAnnotationManager : public QObject
 {
     Q_OBJECT

diff --git a/src/gui/qgsformannotation.h b/src/gui/qgsformannotation.h
@@ -29,13 +29,26 @@ class GUI_EXPORT QgsFormAnnotation: public QgsAnnotation
 {
     Q_OBJECT
   public:
+
+    /**
+     * Constructor for QgsFormAnnotation.
+     */
     QgsFormAnnotation( QObject* parent = nullptr );
 
     QSizeF minimumFrameSize() const override;
     //! Returns the optimal frame size
     QSizeF preferredFrameSize() const;
 
+    /**
+     * Sets the path to the Qt Designer UI file to show in the annotation.
+     * @see designerForm()
+     */
     void setDesignerForm( const QString& uiFile );
+
+    /**
+     * Returns the path to the Qt Designer UI file to show in the annotation.
+     * @see setDesignerForm()
+     */
     QString designerForm() const { return mDesignerForm; }
 
     virtual void writeXml( QDomElement& elem, QDomDocument & doc ) const override;