Add missing docstrings

31 files changed, 244 insertions, 2 deletions

diff --git a/champlain-gtk/gtk-champlain-embed.h b/champlain-gtk/gtk-champlain-embed.h
index b39bc61..42e1b1f 100644
--- a/champlain-gtk/gtk-champlain-embed.h
+++ b/champlain-gtk/gtk-champlain-embed.h
@@ -52,6 +52,14 @@ typedef struct _GtkChamplainEmbed GtkChamplainEmbed;
 
 typedef struct _GtkChamplainEmbedClass GtkChamplainEmbedClass;
 
+/**
+ * GtkChamplainEmbed:
+ *
+ * The #GtkChamplainEmbed structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.4
+ */
 struct _GtkChamplainEmbed
 {
   GtkAlignment bin;
diff --git a/champlain/champlain-coordinate.h b/champlain/champlain-coordinate.h
index 43609d1..5b4d39b 100644
--- a/champlain/champlain-coordinate.h
+++ b/champlain/champlain-coordinate.h
@@ -53,6 +53,14 @@ typedef struct _ChamplainCoordinate ChamplainCoordinate;
 typedef struct _ChamplainCoordinateClass ChamplainCoordinateClass;
 
 
+/**
+ * ChamplainCoordinate:
+ *
+ * The #ChamplainCoordinate structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainCoordinate
 {
   GInitiallyUnowned parent;
diff --git a/champlain/champlain-custom-marker.h b/champlain/champlain-custom-marker.h
index 9cdec59..d27aa91 100644
--- a/champlain/champlain-custom-marker.h
+++ b/champlain/champlain-custom-marker.h
@@ -52,6 +52,14 @@ typedef struct _ChamplainCustomMarkerPrivate ChamplainCustomMarkerPrivate;
 typedef struct _ChamplainCustomMarker ChamplainCustomMarker;
 typedef struct _ChamplainCustomMarkerClass ChamplainCustomMarkerClass;
 
+/**
+ * ChamplainCustomMarker:
+ *
+ * The #ChamplainCustomMarker structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainCustomMarker
 {
   ChamplainMarker parent;
diff --git a/champlain/champlain-error-tile-renderer.h b/champlain/champlain-error-tile-renderer.h
index a31cb8d..5012ef1 100644
--- a/champlain/champlain-error-tile-renderer.h
+++ b/champlain/champlain-error-tile-renderer.h
@@ -50,6 +50,14 @@ typedef struct _ChamplainErrorTileRendererPrivate ChamplainErrorTileRendererPriv
 typedef struct _ChamplainErrorTileRenderer ChamplainErrorTileRenderer;
 typedef struct _ChamplainErrorTileRendererClass ChamplainErrorTileRendererClass;
 
+/**
+ * ChamplainErrorTileRenderer:
+ *
+ * The #ChamplainErrorTileRenderer structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 struct _ChamplainErrorTileRenderer
 {
   ChamplainRenderer parent;
diff --git a/champlain/champlain-file-cache.h b/champlain/champlain-file-cache.h
index 32830e4..ad297c3 100644
--- a/champlain/champlain-file-cache.h
+++ b/champlain/champlain-file-cache.h
@@ -51,6 +51,14 @@ typedef struct _ChamplainFileCachePrivate ChamplainFileCachePrivate;
 typedef struct _ChamplainFileCache ChamplainFileCache;
 typedef struct _ChamplainFileCacheClass ChamplainFileCacheClass;
 
+/**
+ * ChamplainFileCache:
+ *
+ * The #ChamplainFileCache structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.6
+ */
 struct _ChamplainFileCache
 {
   ChamplainTileCache parent_instance;
diff --git a/champlain/champlain-file-tile-source.h b/champlain/champlain-file-tile-source.h
index 1a931f0..88b73c5 100644
--- a/champlain/champlain-file-tile-source.h
+++ b/champlain/champlain-file-tile-source.h
@@ -52,6 +52,14 @@ typedef struct _ChamplainFileTileSourcePrivate ChamplainFileTileSourcePrivate;
 typedef struct _ChamplainFileTileSource ChamplainFileTileSource;
 typedef struct _ChamplainFileTileSourceClass ChamplainFileTileSourceClass;
 
+/**
+ * ChamplainFileTileSource:
+ *
+ * The #ChamplainFileTileSource structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 struct _ChamplainFileTileSource
 {
   ChamplainTileSource parent;
diff --git a/champlain/champlain-image-renderer.h b/champlain/champlain-image-renderer.h
index a5b8e11..75c3c92 100644
--- a/champlain/champlain-image-renderer.h
+++ b/champlain/champlain-image-renderer.h
@@ -50,6 +50,14 @@ typedef struct _ChamplainImageRendererPrivate ChamplainImageRendererPrivate;
 typedef struct _ChamplainImageRenderer ChamplainImageRenderer;
 typedef struct _ChamplainImageRendererClass ChamplainImageRendererClass;
 
+/**
+ * ChamplainImageRenderer:
+ *
+ * The #ChamplainImageRenderer structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 struct _ChamplainImageRenderer
 {
   ChamplainRenderer parent;
diff --git a/champlain/champlain-label.h b/champlain/champlain-label.h
index 4b4c9a3..6f8a34d 100644
--- a/champlain/champlain-label.h
+++ b/champlain/champlain-label.h
@@ -53,6 +53,14 @@ typedef struct _ChamplainLabelPrivate ChamplainLabelPrivate;
 typedef struct _ChamplainLabel ChamplainLabel;
 typedef struct _ChamplainLabelClass ChamplainLabelClass;
 
+/**
+ * ChamplainLabel:
+ *
+ * The #ChamplainLabel structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainLabel
 {
   ChamplainMarker parent;
diff --git a/champlain/champlain-layer.h b/champlain/champlain-layer.h
index 28126ad..d5c0f27 100644
--- a/champlain/champlain-layer.h
+++ b/champlain/champlain-layer.h
@@ -49,6 +49,14 @@ G_BEGIN_DECLS
 typedef struct _ChamplainLayer ChamplainLayer;
 typedef struct _ChamplainLayerClass ChamplainLayerClass;
 
+/**
+ * ChamplainLayer:
+ *
+ * The #ChamplainLayer structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainLayer
 {
   ClutterActor parent;
diff --git a/champlain/champlain-license.h b/champlain/champlain-license.h
index 88009e6..99ab329 100644
--- a/champlain/champlain-license.h
+++ b/champlain/champlain-license.h
@@ -53,6 +53,14 @@ typedef struct _ChamplainLicense ChamplainLicense;
 typedef struct _ChamplainLicenseClass ChamplainLicenseClass;
 
 
+/**
+ * ChamplainLicense:
+ *
+ * The #ChamplainLicense structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainLicense
 {
   ClutterActor parent;
diff --git a/champlain/champlain-map-source-chain.h b/champlain/champlain-map-source-chain.h
index efbd28c..0f939b2 100644
--- a/champlain/champlain-map-source-chain.h
+++ b/champlain/champlain-map-source-chain.h
@@ -51,6 +51,14 @@ typedef struct _ChamplainMapSourceChainPrivate ChamplainMapSourceChainPrivate;
 typedef struct _ChamplainMapSourceChain ChamplainMapSourceChain;
 typedef struct _ChamplainMapSourceChainClass ChamplainMapSourceChainClass;
 
+/**
+ * ChamplainMapSourceChain:
+ *
+ * The #ChamplainMapSourceChain structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.6
+ */
 struct _ChamplainMapSourceChain
 {
   ChamplainMapSource parent_instance;
diff --git a/champlain/champlain-map-source-desc.h b/champlain/champlain-map-source-desc.h
index 145cc36..b09dd16 100644
--- a/champlain/champlain-map-source-desc.h
+++ b/champlain/champlain-map-source-desc.h
@@ -51,6 +51,14 @@ typedef struct _ChamplainMapSourceDescPrivate ChamplainMapSourceDescPrivate;
 typedef struct _ChamplainMapSourceDesc ChamplainMapSourceDesc;
 typedef struct _ChamplainMapSourceDescClass ChamplainMapSourceDescClass;
 
+/**
+ * ChamplainMapSourceDesc:
+ *
+ * The #ChamplainMapSourceDesc structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainMapSourceDesc
 {
   GObject parent_instance;
@@ -74,9 +82,15 @@ struct _ChamplainMapSourceDescClass
  *
  * Since: 0.10
  */
-typedef ChamplainMapSource * (*ChamplainMapSourceConstructor)
-  (ChamplainMapSourceDesc *desc);
+typedef ChamplainMapSource* (*ChamplainMapSourceConstructor) (ChamplainMapSourceDesc *desc);
 
+/**
+ * CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR:
+ *
+ * Conversion macro to #ChamplainMapSourceConstructor.
+ *
+ * Since: 0.10
+ */
 #define CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR (f) ((ChamplainMapSourceConstructor) (f))
 
 GType champlain_map_source_desc_get_type (void);
diff --git a/champlain/champlain-map-source-factory.h b/champlain/champlain-map-source-factory.h
index 774683e..bd9d2d3 100644
--- a/champlain/champlain-map-source-factory.h
+++ b/champlain/champlain-map-source-factory.h
@@ -55,6 +55,14 @@ typedef struct _ChamplainMapSourceFactoryPrivate ChamplainMapSourceFactoryPrivat
 typedef struct _ChamplainMapSourceFactory ChamplainMapSourceFactory;
 typedef struct _ChamplainMapSourceFactoryClass ChamplainMapSourceFactoryClass;
 
+/**
+ * ChamplainMapSourceFactory:
+ *
+ * The #ChamplainMapSourceFactory structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.4
+ */
 struct _ChamplainMapSourceFactory
 {
   GObject parent;
diff --git a/champlain/champlain-map-source.h b/champlain/champlain-map-source.h
index fa3de84..5bd599d 100644
--- a/champlain/champlain-map-source.h
+++ b/champlain/champlain-map-source.h
@@ -61,6 +61,14 @@ typedef enum
   CHAMPLAIN_MAP_PROJECTION_MERCATOR
 } ChamplainMapProjection;
 
+/**
+ * ChamplainMapSource:
+ *
+ * The #ChamplainMapSource structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.4
+ */
 struct _ChamplainMapSource
 {
   GInitiallyUnowned parent_instance;
diff --git a/champlain/champlain-marker-layer.h b/champlain/champlain-marker-layer.h
index b830f94..fd6e42b 100644
--- a/champlain/champlain-marker-layer.h
+++ b/champlain/champlain-marker-layer.h
@@ -71,6 +71,14 @@ typedef enum
   CHAMPLAIN_SELECTION_MULTIPLE
 } ChamplainSelectionMode;
 
+/**
+ * ChamplainMarkerLayer:
+ *
+ * The #ChamplainMarkerLayer structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainMarkerLayer
 {
   ChamplainLayer parent;
diff --git a/champlain/champlain-marker.h b/champlain/champlain-marker.h
index 4f03375..8f190d4 100644
--- a/champlain/champlain-marker.h
+++ b/champlain/champlain-marker.h
@@ -55,6 +55,14 @@ typedef struct _ChamplainMarker ChamplainMarker;
 typedef struct _ChamplainMarkerClass ChamplainMarkerClass;
 
 
+/**
+ * ChamplainMarker:
+ *
+ * The #ChamplainMarker structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainMarker
 {
   ClutterActor parent;
diff --git a/champlain/champlain-memory-cache.h b/champlain/champlain-memory-cache.h
index 1f9f576..b0bd972 100644
--- a/champlain/champlain-memory-cache.h
+++ b/champlain/champlain-memory-cache.h
@@ -50,6 +50,14 @@ typedef struct _ChamplainMemoryCachePrivate ChamplainMemoryCachePrivate;
 typedef struct _ChamplainMemoryCache ChamplainMemoryCache;
 typedef struct _ChamplainMemoryCacheClass ChamplainMemoryCacheClass;
 
+/**
+ * ChamplainMemoryCache:
+ *
+ * The #ChamplainMemoryCache structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 struct _ChamplainMemoryCache
 {
   ChamplainTileCache parent_instance;
diff --git a/champlain/champlain-memphis-renderer.h b/champlain/champlain-memphis-renderer.h
index 361d3ed..bb2610f 100644
--- a/champlain/champlain-memphis-renderer.h
+++ b/champlain/champlain-memphis-renderer.h
@@ -76,6 +76,14 @@ typedef enum
   CHAMPLAIN_MEMPHIS_RULE_TYPE_RELATION
 } ChamplainMemphisRuleType;
 
+/**
+ * ChamplainMemphisRenderer:
+ *
+ * The #ChamplainMemphisRenderer structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 struct _ChamplainMemphisRenderer
 {
   ChamplainRenderer parent;
diff --git a/champlain/champlain-network-bbox-tile-source.h b/champlain/champlain-network-bbox-tile-source.h
index de8f971..f5e4ab9 100644
--- a/champlain/champlain-network-bbox-tile-source.h
+++ b/champlain/champlain-network-bbox-tile-source.h
@@ -49,6 +49,14 @@ typedef struct _ChamplainNetworkBboxTileSourcePrivate ChamplainNetworkBboxTileSo
 typedef struct _ChamplainNetworkBboxTileSource ChamplainNetworkBboxTileSource;
 typedef struct _ChamplainNetworkBboxTileSourceClass ChamplainNetworkBboxTileSourceClass;
 
+/**
+ * ChamplainNetworkBboxTileSource:
+ *
+ * The #ChamplainNetworkBboxTileSource structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 struct _ChamplainNetworkBboxTileSource
 {
   ChamplainTileSource parent;
diff --git a/champlain/champlain-network-tile-source.h b/champlain/champlain-network-tile-source.h
index 51c3577..740494e 100644
--- a/champlain/champlain-network-tile-source.h
+++ b/champlain/champlain-network-tile-source.h
@@ -51,6 +51,14 @@ typedef struct _ChamplainNetworkTileSourcePrivate ChamplainNetworkTileSourcePriv
 typedef struct _ChamplainNetworkTileSource ChamplainNetworkTileSource;
 typedef struct _ChamplainNetworkTileSourceClass ChamplainNetworkTileSourceClass;
 
+/**
+ * ChamplainNetworkTileSource:
+ *
+ * The #ChamplainNetworkTileSource structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.6
+ */
 struct _ChamplainNetworkTileSource
 {
   ChamplainTileSource parent_instance;
diff --git a/champlain/champlain-null-tile-source.h b/champlain/champlain-null-tile-source.h
index 07cf83e..2a56687 100644
--- a/champlain/champlain-null-tile-source.h
+++ b/champlain/champlain-null-tile-source.h
@@ -48,6 +48,14 @@ G_BEGIN_DECLS
 
 typedef struct _ChamplainNullTileSourcePrivate ChamplainNullTileSourcePrivate;
 
+/**
+ * ChamplainNullTileSource:
+ *
+ * The #ChamplainNullTileSource structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 typedef struct _ChamplainNullTileSource ChamplainNullTileSource;
 typedef struct _ChamplainNullTileSourceClass ChamplainNullTileSourceClass;
 
diff --git a/champlain/champlain-path-layer.h b/champlain/champlain-path-layer.h
index 1a079b6..222ffb5 100644
--- a/champlain/champlain-path-layer.h
+++ b/champlain/champlain-path-layer.h
@@ -57,6 +57,14 @@ typedef struct _ChamplainPathLayer ChamplainPathLayer;
 typedef struct _ChamplainPathLayerClass ChamplainPathLayerClass;
 
 
+/**
+ * ChamplainPathLayer:
+ *
+ * The #ChamplainPathLayer structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainPathLayer
 {
   ChamplainLayer parent;
diff --git a/champlain/champlain-point.h b/champlain/champlain-point.h
index 405eebb..58271fc 100644
--- a/champlain/champlain-point.h
+++ b/champlain/champlain-point.h
@@ -52,6 +52,14 @@ typedef struct _ChamplainPointPrivate ChamplainPointPrivate;
 typedef struct _ChamplainPoint ChamplainPoint;
 typedef struct _ChamplainPointClass ChamplainPointClass;
 
+/**
+ * ChamplainPoint:
+ *
+ * The #ChamplainPoint structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainPoint
 {
   ChamplainMarker parent;
diff --git a/champlain/champlain-renderer.h b/champlain/champlain-renderer.h
index 240b762..b2cf3e3 100644
--- a/champlain/champlain-renderer.h
+++ b/champlain/champlain-renderer.h
@@ -48,6 +48,14 @@ typedef struct _ChamplainRenderer ChamplainRenderer;
 typedef struct _ChamplainRendererClass ChamplainRendererClass;
 
 
+/**
+ * ChamplainRenderer:
+ *
+ * The #ChamplainRenderer structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.8
+ */
 struct _ChamplainRenderer
 {
   GInitiallyUnowned parent;
diff --git a/champlain/champlain-scale.h b/champlain/champlain-scale.h
index d97b1a2..fa0a42b 100644
--- a/champlain/champlain-scale.h
+++ b/champlain/champlain-scale.h
@@ -65,6 +65,14 @@ typedef enum
   CHAMPLAIN_UNIT_MILES,
 } ChamplainUnit;
 
+/**
+ * ChamplainScale:
+ *
+ * The #ChamplainScale structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.10
+ */
 struct _ChamplainScale
 {
   ClutterActor parent;
diff --git a/champlain/champlain-tile-cache.h b/champlain/champlain-tile-cache.h
index dc61303..e1856cd 100644
--- a/champlain/champlain-tile-cache.h
+++ b/champlain/champlain-tile-cache.h
@@ -50,6 +50,14 @@ typedef struct _ChamplainTileCachePrivate ChamplainTileCachePrivate;
 typedef struct _ChamplainTileCache ChamplainTileCache;
 typedef struct _ChamplainTileCacheClass ChamplainTileCacheClass;
 
+/**
+ * ChamplainTileCache:
+ *
+ * The #ChamplainTileCache structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.6
+ */
 struct _ChamplainTileCache
 {
   ChamplainMapSource parent_instance;
diff --git a/champlain/champlain-tile-source.h b/champlain/champlain-tile-source.h
index 584f291..1ffb682 100644
--- a/champlain/champlain-tile-source.h
+++ b/champlain/champlain-tile-source.h
@@ -52,6 +52,14 @@ typedef struct _ChamplainTileSourcePrivate ChamplainTileSourcePrivate;
 typedef struct _ChamplainTileSource ChamplainTileSource;
 typedef struct _ChamplainTileSourceClass ChamplainTileSourceClass;
 
+/**
+ * ChamplainTileSource:
+ *
+ * The #ChamplainTileSource structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.6
+ */
 struct _ChamplainTileSource
 {
   ChamplainMapSource parent_instance;
diff --git a/champlain/champlain-tile.h b/champlain/champlain-tile.h
index 2c7c87f..78e56ed 100644
--- a/champlain/champlain-tile.h
+++ b/champlain/champlain-tile.h
@@ -68,6 +68,14 @@ typedef enum
 } ChamplainState;
 
 
+/**
+ * ChamplainTile:
+ *
+ * The #ChamplainTile structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.4
+ */
 struct _ChamplainTile
 {
   ClutterActor parent;
diff --git a/champlain/champlain-view.h b/champlain/champlain-view.h
index 8fd48ac..832282a 100644
--- a/champlain/champlain-view.h
+++ b/champlain/champlain-view.h
@@ -56,6 +56,14 @@ G_BEGIN_DECLS
 typedef struct _ChamplainViewPrivate ChamplainViewPrivate;
 
 
+/**
+ * ChamplainView:
+ *
+ * The #ChamplainView structure contains only private data
+ * and should be accessed using the provided API
+ *
+ * Since: 0.1
+ */
 struct _ChamplainView
 {
   ClutterActor parent;
diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml
index ee55648..b1d91dd 100644
--- a/docs/reference/libchamplain-docs.sgml
+++ b/docs/reference/libchamplain-docs.sgml
@@ -106,6 +106,9 @@
     <xi:include href="xml/champlain-tile.xml"/>
     <xi:include href="xml/champlain-bounding-box.xml"/>
     <xi:include href="xml/champlain-version.xml"/>
+  </part>
+  <part>
+    <title>Annotation Glossary</title>
     <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
   </part>
 
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index 7938380..9c5f17f 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -647,6 +647,7 @@ ChamplainImageRendererPrivate
 <FILE>champlain-map-source-desc</FILE>
 <TITLE>ChamplainMapSourceDesc</TITLE>
 ChamplainMapSourceDesc
+ChamplainMapSourceConstructor
 CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR
 champlain_map_source_desc_new_full
 champlain_map_source_desc_get_id