Document GisPluginSat
authorAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 22:30:44 +0000 (22:30 +0000)
committerAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 22:30:53 +0000 (22:30 +0000)
src/plugins/sat.c

index 4856ae65b81acb07b420b55bbccf61f19d463082..488a4e505f76986e4b4cbeed41183f71fca88ff9 100644 (file)
  * 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");