From: Pierre-Luc Beaudoin <pierre-luc@pierlux.com>
Date: Sat, 2 May 2009 06:04:59 +0000 (-0400)
Subject: Update documentation
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ebde18435afbbe983cdf2ba057d847f1c8a6cf75;p=libchamplain

Update documentation
---

diff --git a/champlain/champlain-cache.c b/champlain/champlain-cache.c
index 32d934c..820ea68 100644
--- a/champlain/champlain-cache.c
+++ b/champlain/champlain-cache.c
@@ -188,7 +188,7 @@ cleanup:
 /**
  * champlain_cache_get_default:
  *
- * Return the #ChamplainCache singleton
+ * Returns the #ChamplainCache singleton
  *
  * Since: 0.4
  */
@@ -405,7 +405,7 @@ delete_tile (ChamplainCache *self,
  * champlain_cache_update_tile:
  * @self: the #ChamplainCache
  * @tile: the #ChamplainTile to fill
- * @size: the filesize on the disk
+ * @filesize: the filesize on the disk
  *
  * Update the tile's information in the cache such as Etag and filesize.
  * Also increase the tile's popularity.
@@ -415,7 +415,7 @@ delete_tile (ChamplainCache *self,
 void
 champlain_cache_update_tile (ChamplainCache *self,
     ChamplainTile *tile,
-    guint size)
+    guint filesize)
 {
   g_return_if_fail (CHAMPLAIN_CACHE (self));
   gchar *query, *error = NULL;
@@ -425,7 +425,7 @@ champlain_cache_update_tile (ChamplainCache *self,
   query = g_strdup_printf ("REPLACE INTO tiles (filename, etag, size) VALUES ('%s', '%s', %d);",
       champlain_tile_get_filename (tile),
       champlain_tile_get_etag (tile),
-      size);
+      filesize);
   sqlite3_exec (priv->data, query, NULL, NULL, &error);
   if (error != NULL)
     {
diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml
index 6425c24..236498b 100644
--- a/docs/reference/libchamplain-docs.sgml
+++ b/docs/reference/libchamplain-docs.sgml
@@ -52,7 +52,7 @@
     <xi:include href="xml/champlain-map-source.xml"/>
     <xi:include href="xml/champlain-network-map-source.xml"/>
     <xi:include href="xml/champlain-tile.xml"/>
-    <xi:include href="xml/champlain-zoom-level.xml"/>
+    <xi:include href="xml/champlain-cache.xml"/>
   </chapter>
   <index>
     <title>Index</title>
diff --git a/docs/reference/libchamplain-gtk-docs.sgml b/docs/reference/libchamplain-gtk-docs.sgml
deleted file mode 100644
index 5358797..0000000
--- a/docs/reference/libchamplain-gtk-docs.sgml
+++ /dev/null
@@ -1,20 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<!ENTITY version SYSTEM "version.xml">
-]>
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
-  <bookinfo>
-    <title>libchamplain-gtk Reference Manual</title>
-    <releaseinfo>
-      for libchamplain-gtk &version;
-      The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://blog.pierlux.com/projects/libchamplain/">http://blog.pierlux.com/projects/libchamplain/</ulink>.
-    </releaseinfo>
-  </bookinfo>
-
-  <chapter>
-    <title>I. API Reference</title>
-    <xi:include href="xml/champlainviewembed.xml"/>
-  </chapter>
-</book>
diff --git a/docs/reference/libchamplain-gtk-sections.txt b/docs/reference/libchamplain-gtk-sections.txt
deleted file mode 100644
index a04f9c2..0000000
--- a/docs/reference/libchamplain-gtk-sections.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-<SECTION>
-<FILE>champlainviewembed</FILE>
-<TITLE>ChamplainViewEmbed</TITLE>
-champlain_view_embed_new
-champlain_view_embed_get_view
-<SUBSECTION Standard>
-CHAMPLAIN_VIEW_EMBED
-CHAMPLAIN_IS_VIEW_EMBED
-CHAMPLAIN_TYPE_VIEW_EMBED
-champlain_view_embed_get_type
-CHAMPLAIN_VIEW_EMBED_CLASS
-CHAMPLAIN_IS_VIEW_EMBED_CLASS
-CHAMPLAIN_VIEW_EMBED_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>champlain-gtk-marshal</FILE>
-</SECTION>
-
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index bccf7d0..cc5a44a 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -294,3 +294,18 @@ CHAMPLAIN_PARAM_READWRITE
 ChamplainState
 </SECTION>
 
+<SECTION>
+<FILE>champlain-cache</FILE>
+ChamplainCache
+ChamplainCacheClass
+champlain_cache_fill_tile
+champlain_cache_get_default
+champlain_cache_get_size_limit
+champlain_cache_get_type
+champlain_cache_purge
+champlain_cache_purge_on_idle
+champlain_cache_set_size_limit
+champlain_cache_tile_is_expired
+champlain_cache_update_tile
+</SECTION>
+
diff --git a/docs/reference/libchamplain.types b/docs/reference/libchamplain.types
index f13ddb4..db39995 100644
--- a/docs/reference/libchamplain.types
+++ b/docs/reference/libchamplain.types
@@ -1,10 +1,10 @@
 #include <champlain.h>
 
 champlain_view_get_type
-champlain_marker_get_type
 champlain_base_marker_get_type
+champlain_marker_get_type
 champlain_layer_get_type
 champlain_map_source_get_type
 champlain_network_map_source_get_type
-champlain_zoom_level_get_type
 champlain_tile_get_type
+champlain_cache_get_type