Improve doc

diff --git a/champlain/champlainmarker.c b/champlain/champlainmarker.c
index 7fe3b508489aa62d4f966ea05bb6d766384f02e8..d16610dd68ca03936d314e82557e959ce4fe0af8 100644 (file)
--- a/champlain/champlainmarker.c
+++ b/champlain/champlainmarker.c
@@ -163,7 +163,7 @@ champlain_marker_init (ChamplainMarker *champlainMarker)
 /**
  * champlain_marker_new:
  *
- * Returns a new #ChamplainWidget ready to be used as a #ClutterActor.
+ * Returns a new #ChamplainMarker ready to be used as a #ClutterActor.
  *
  * Since: 0.2
  */
@@ -229,7 +229,7 @@ champlain_marker_set_anchor (ChamplainMarker *champlainMarker, gint x, gint y)
  * @text_color: a #ClutterColor, the color of the text, can be NULL
  * @marker_color: a #ClutterColor, the color of the marker, can be NULL
  *
- * Returns a new #ChamplainWidget with a drawn marker containing the given text. 
+ * Returns a new #ChamplainMarker with a drawn marker containing the given text. 
  *
  * Since: 0.2
  */

diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml
index 7ce90b20fc0e66e2d2593e2a21103baff70cde7b..a63dfd937c283450ce5f10d5ff32248cf5c6a74b 100644 (file)
--- a/docs/reference/libchamplain-docs.sgml
+++ b/docs/reference/libchamplain-docs.sgml
@@ -14,5 +14,6 @@
   <chapter>
     <title>I. API Reference</title>
     <xi:include href="xml/champlainview.xml"/>
+    <xi:include href="xml/champlainmarker.xml"/>
   </chapter>
 </book>

diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index 666e59b0c28057d94c16ef286ce1c2f72f1dfb46..28599207011ce7cf76837d78359ee2ce57503adf 100644 (file)
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -4,9 +4,6 @@
 <INCLUDE>champlain/champlainview.h</INCLUDE>
 ChamplainMapSource
 ChamplainViewMode
-CHAMPLAIN_CLASS
-CHAMPLAIN_GET_CLASS
-ChamplainViewPrivate
 ChamplainView
 champlain_view_get_type
 champlain_view_new
@@ -19,6 +16,17 @@ CHAMPLAIN_IS_VIEW
 CHAMPLAIN_TYPE_VIEW
 CHAMPLAIN_IS_VIEW_CLASS
 </SECTION>
+<SECTION>
+<FILE>champlainmarker</FILE>
+<TITLE>ChamplainMarker</TITLE>
+<INCLUDE>champlain/champlainmarker.h</INCLUDE>
+ChamplainMarker
+champlain_marker_get_type
+champlain_marker_new
+champlain_marker_new_with_label
+champlain_marker_set_anchor
+champlain_marker_set_position
+</SECTION>
 
 <SECTION>
 <FILE>champlain</FILE>

diff --git a/docs/reference/tmpl/champlainmarker.sgml b/docs/reference/tmpl/champlainmarker.sgml
new file mode 100644 (file)
index 0000000..1dc25a4
--- /dev/null
+++ b/docs/reference/tmpl/champlainmarker.sgml
@@ -0,0 +1,77 @@
+<!-- ##### SECTION Title ##### -->
+ChamplainMarker
+
+<!-- ##### SECTION Short_Description ##### -->
+A marker to identify points of interest on a map
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>Markers reprensent points of interest on a map. Markers need to be placed on a layer (a #ClutterGroup).  Layers have to be added to a #ChamplainView for the markers to show on the map.</para>
+
+<para>A marker is nothing more than a regular #ClutterActor.  You can draw on it what ever you want.  Don't forget to set the anchor position in the marker using #champlain_marker_set_anchor.  Set the markers position on the map using #champlain_marker_set_position.</para>
+
+<para>Champlain has a default type of markers with text. To create one, use #champlain_marker_new_with_label.</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT ChamplainMarker ##### -->
+<para>
+
+</para>
+
+@group: 
+@priv: 
+
+<!-- ##### FUNCTION champlain_marker_get_type ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION champlain_marker_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION champlain_marker_new_with_label ##### -->
+<para>
+
+</para>
+
+@label: 
+@font: 
+@text_color: 
+@marker_color: 
+@Returns: 
+
+
+<!-- ##### FUNCTION champlain_marker_set_anchor ##### -->
+<para>
+
+</para>
+
+@marker: 
+@x: 
+@y: 
+
+
+<!-- ##### FUNCTION champlain_marker_set_position ##### -->
+<para>
+
+</para>
+
+@marker: 
+@longitude: 
+@latitude: 
+
+

diff --git a/docs/reference/tmpl/champlainview.sgml b/docs/reference/tmpl/champlainview.sgml
new file mode 100644 (file)
index 0000000..fa75da2
--- /dev/null
+++ b/docs/reference/tmpl/champlainview.sgml
@@ -0,0 +1,131 @@
+<!-- ##### SECTION Title ##### -->
+ChamplainView
+
+<!-- ##### SECTION Short_Description ##### -->
+A widget to display maps
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The #ChamplainView widget is a Clutter based widget to display maps.  It supports two modes of scrolling:
+<itemizedlist>
+  <listitem><para>Push: the normal behavior where the maps doesn't move after the user stopped scrolling;</para></listitem>
+  <listitem><para>Kinetic: the iPhone-like behavior where the maps decelerate after the user stopped scrolling.</para></listitem>
+</itemizedlist>
+</para>
+<para>
+You can use the same #ChamplainView to display many types of maps.  In Champlain they are called map sources.  You can change the #map-source property at anytime to replace the current displayed map.
+</para>
+<para>
+The maps are downloaded from Internet from open maps sources (like <ulink role="online-location" url="http://www.openstreetmap.org">OpenStreetMap</ulink>).  Maps are divided in tiles for each zoom level.  When a tile is requested, #ChamplainView will first check if it is in cache (in
+the user's cache dir under champlain). If an error occurs during download, an error tile will be displayed (if not in offline mode).
+</para>
+
+<para>
+
+</para>
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### ENUM ChamplainMapSource ##### -->
+<para>
+
+</para>
+
+@CHAMPLAIN_MAP_SOURCE_DEBUG: 
+@CHAMPLAIN_MAP_SOURCE_OPENSTREETMAP: 
+@CHAMPLAIN_MAP_SOURCE_OPENARIALMAP: 
+@CHAMPLAIN_MAP_SOURCE_MAPSFORFREE_RELIEF: 
+@CHAMPLAIN_MAP_SOURCE_COUNT: 
+
+<!-- ##### ENUM ChamplainViewMode ##### -->
+<para>
+
+</para>
+
+@CHAMPLAIN_VIEW_MODE_PUSH: 
+@CHAMPLAIN_VIEW_MODE_KINETIC: 
+
+<!-- ##### STRUCT ChamplainView ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG ChamplainView:decel-rate ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ChamplainView:latitude ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ChamplainView:longitude ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ChamplainView:map-source ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ChamplainView:offline ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ChamplainView:zoom-level ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION champlain_view_get_type ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION champlain_view_new ##### -->
+<para>
+
+</para>
+
+@mode: 
+@Returns: 
+
+
+<!-- ##### FUNCTION champlain_view_center_on ##### -->
+<para>
+
+</para>
+
+@view: 
+@longitude: 
+@latitude: 
+
+
+<!-- ##### FUNCTION champlain_view_zoom_in ##### -->
+<para>
+
+</para>
+
+@champlainView: 
+
+
+<!-- ##### FUNCTION champlain_view_zoom_out ##### -->
+<para>
+
+</para>
+
+@champlainView: 
+
+