[libchamplainmm] Label: Add class documentation



commit c0ae2c39c71a62466ba978c54a138610e551f962
Author: Juan R. GarcĂ­a Blanco <juanrgar gmail com>
Date:   Sun Mar 2 16:44:02 2014 +0100

    Label: Add class documentation
    
        * Add documentation block for Label class.

 champlain/src/label.hg |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)
---
diff --git a/champlain/src/label.hg b/champlain/src/label.hg
index ed38732..567cf68 100644
--- a/champlain/src/label.hg
+++ b/champlain/src/label.hg
@@ -29,6 +29,18 @@ _PINCLUDE(champlainmm/private/marker_p.h)
 namespace Champlain
 {
 
+/** A label to identify points of interest on a map.
+ *
+ * Markers reprensent points of interest on a map. Markers need to be placed on
+ * a layer (a MarkerLayer). Layers have to be added to a View for
+ * the markers to show on the map.
+ *
+ * A marker is nothing more than a regular Clutter::Actor. You can draw on it
+ * whatever you want. Set the marker's position on the map
+ * using set_location().
+ *
+ * @newin{0,10}
+ */
 class Label : public Marker
 {
   _CLASS_GOBJECT(Label, ChamplainLabel, CHAMPLAIN_LABEL, Marker, ChamplainMarker)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]