From: Andy Spencer <andy753421@gmail.com>
Date: Mon, 8 Feb 2010 22:30:44 +0000 (+0000)
Subject: Document GisPluginSat
X-Git-Tag: v0.4~50
X-Git-Url: http://pileus.org/git/?p=grits;a=commitdiff_plain;h=ac42864a884cc648566382edbe7a3c0c9b819baf

Document GisPluginSat
---

diff --git a/src/plugins/sat.c b/src/plugins/sat.c
index 4856ae6..488a4e5 100644
--- a/src/plugins/sat.c
+++ b/src/plugins/sat.c
@@ -15,6 +15,14 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:sat
+ * @short_description: Satellite plugin
+ *
+ * #GisPluginSat provides overlays using satellite imagery. This is mostly
+ * provided by NASA's Blue Marble Next Generation.
+ */
+
 #include <time.h>
 #include <glib/gstdio.h>
 #include <GL/gl.h>
@@ -129,6 +137,14 @@ static void _on_location_changed(GisViewer *viewer,
 /***********
  * Methods *
  ***********/
+/**
+ * gis_plugin_sat_new:
+ * @viewer: the #GisViewer to use for drawing
+ *
+ * Create a new instance of the satellite plugin.
+ *
+ * Returns: the new #GisPluginSat
+ */
 GisPluginSat *gis_plugin_sat_new(GisViewer *viewer)
 {
 	g_debug("GisPluginSat: new");