Add documentation blocks for most sections

15 files changed, 108 insertions, 0 deletions

diff --git a/gst-streaming-server/gss-config.c b/gst-streaming-server/gss-config.c
index 8c4e520..1f7a2b1 100644
--- a/gst-streaming-server/gss-config.c
+++ b/gst-streaming-server/gss-config.c
@@ -34,6 +34,20 @@
 
 #include <libxml/parser.h>
 
+/**
+ * SECTION:gss-config
+ * @short_description: Class for handling configuration
+ * @see_also: #GssServer
+ *
+ * GssConfig stores configuration options for instances of subclasses
+ * of GObject.  Objects are "attached" to the GssConfig object in order
+ * to have the config object manage its configuration.  GssConfig will
+ * read and write to a configuration file, in XML format.
+ *
+ * GssConfig can also automatically create objects from their
+ * representation in the XML file.
+ */
+
 enum
 {
   PROP_0,
diff --git a/gst-streaming-server/gss-html.c b/gst-streaming-server/gss-html.c
index b9a04e7..aec5423 100644
--- a/gst-streaming-server/gss-html.c
+++ b/gst-streaming-server/gss-html.c
@@ -27,6 +27,12 @@
 
 #include <string.h>
 
+/**
+ * SECTION:gss-html
+ * @short_description: Functions for generating HTML
+ * @see_also: #GssTransaction
+ *
+ */
 
 void
 gss_html_error_404 (GssServer * server, SoupMessage * msg)
diff --git a/gst-streaming-server/gss-isom.c b/gst-streaming-server/gss-isom.c
index 797306f..f9b88ce 100644
--- a/gst-streaming-server/gss-isom.c
+++ b/gst-streaming-server/gss-isom.c
@@ -43,6 +43,12 @@
 #include <fcntl.h>
 #include <openssl/aes.h>
 
+/**
+ * SECTION:gss-isom
+ * @short_description: Functions for manipulating ISO Media files
+ *
+ */
+
 typedef struct _Container Container;
 struct _Container
 {
diff --git a/gst-streaming-server/gss-log.c b/gst-streaming-server/gss-log.c
index dbab626..bf9ba07 100644
--- a/gst-streaming-server/gss-log.c
+++ b/gst-streaming-server/gss-log.c
@@ -12,6 +12,13 @@
 
 #define ENABLE_DEBUG
 
+/**
+ * SECTION:gss-log
+ * @short_description: Functions for handling logging using the GStreamer
+ *   logging system
+ *
+ */
+
 static int gss_log_verbosity = 0;
 
 static void log_handler (GstDebugCategory * category, GstDebugLevel level,
diff --git a/gst-streaming-server/gss-manager.c b/gst-streaming-server/gss-manager.c
index 001d342..7a9c5e6 100644
--- a/gst-streaming-server/gss-manager.c
+++ b/gst-streaming-server/gss-manager.c
@@ -32,6 +32,13 @@
 #include <netinet/in.h>
 #include <net/if.h>
 
+/**
+ * SECTION:gss-manager
+ * @short_description: Class that manages live streams
+ * @see_also: #GssProgram
+ *
+ */
+
 enum
 {
   PROP_0,
diff --git a/gst-streaming-server/gss-metrics.c b/gst-streaming-server/gss-metrics.c
index 56d3bcb..89ef5f3 100644
--- a/gst-streaming-server/gss-metrics.c
+++ b/gst-streaming-server/gss-metrics.c
@@ -23,6 +23,13 @@
 
 #include "gss-server.h"
 
+/**
+ * SECTION:gss-metrics
+ * @short_description: Structure that keeps track of metrics
+ * @see_also: #GssProgram
+ *
+ */
+
 
 GssMetrics *
 gss_metrics_new (void)
diff --git a/gst-streaming-server/gss-module.c b/gst-streaming-server/gss-module.c
index 579c43b..9274610 100644
--- a/gst-streaming-server/gss-module.c
+++ b/gst-streaming-server/gss-module.c
@@ -25,6 +25,13 @@
 #include "gss-utils.h"
 #include "gss-html.h"
 
+/**
+ * SECTION:gss-module
+ * @short_description: Base class for functionality that can be added to servers
+ * @see_also: #GssServer
+ *
+ */
+
 enum
 {
   MOO
diff --git a/gst-streaming-server/gss-object.c b/gst-streaming-server/gss-object.c
index 6fb92a5..5de1076 100644
--- a/gst-streaming-server/gss-object.c
+++ b/gst-streaming-server/gss-object.c
@@ -25,6 +25,12 @@
 #include "gss-utils.h"
 #include "gss-html.h"
 
+/**
+ * SECTION:gss-object
+ * @short_description: Base class for objects that are part of GSS
+ *
+ */
+
 enum
 {
   PROP_NAME = 1,
diff --git a/gst-streaming-server/gss-playready.c b/gst-streaming-server/gss-playready.c
index 954fa65..23521c4 100644
--- a/gst-streaming-server/gss-playready.c
+++ b/gst-streaming-server/gss-playready.c
@@ -17,6 +17,12 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:gss-playready
+ * @short_description: Module that handles content encryption
+ *
+ */
+
 /*
  * Documentation on PlayReady is available here:
  * available at:
diff --git a/gst-streaming-server/gss-program.c b/gst-streaming-server/gss-program.c
index 562432f..a2ac310 100644
--- a/gst-streaming-server/gss-program.c
+++ b/gst-streaming-server/gss-program.c
@@ -27,6 +27,12 @@
 #include "gss-content.h"
 #include "gss-utils.h"
 
+/**
+ * SECTION:gss-program
+ * @short_description: Class that manages several similar steams
+ *
+ */
+
 enum
 {
   PROP_NONE,
diff --git a/gst-streaming-server/gss-pull.c b/gst-streaming-server/gss-pull.c
index 59696a7..b39eafe 100644
--- a/gst-streaming-server/gss-pull.c
+++ b/gst-streaming-server/gss-pull.c
@@ -30,6 +30,14 @@
 
 #include <stdio.h>
 
+/**
+ * SECTION:gss-pull
+ * @short_description: Class that handles live streams that are pulled
+ *   from a source
+ * @see_also: #GssProgram, #GssPush
+ *
+ */
+
 enum
 {
   PROP_NONE,
diff --git a/gst-streaming-server/gss-push.c b/gst-streaming-server/gss-push.c
index 7e0f685..b0d54e7 100644
--- a/gst-streaming-server/gss-push.c
+++ b/gst-streaming-server/gss-push.c
@@ -28,6 +28,14 @@
 #include "gss-content.h"
 #include "gss-utils.h"
 
+/**
+ * SECTION:gss-push
+ * @short_description: Class that handles live streams that are pushed
+ *   from a client
+ * @see_also: #GssProgram, #GssPull
+ *
+ */
+
 enum
 {
   PROP_NONE,
diff --git a/gst-streaming-server/gss-resource.c b/gst-streaming-server/gss-resource.c
index b6a1b65..0d57882 100644
--- a/gst-streaming-server/gss-resource.c
+++ b/gst-streaming-server/gss-resource.c
@@ -26,6 +26,14 @@
 #include "gss-soup.h"
 #include "gss-utils.h"
 
+/**
+ * SECTION:gss-resource
+ * @short_description: Structure that represents a URL or endpoint in
+ *   a server
+ * @see_also: #GssServer
+ *
+ */
+
 
 
 
diff --git a/gst-streaming-server/gss-rtsp.c b/gst-streaming-server/gss-rtsp.c
index 2e9009b..c183b8c 100644
--- a/gst-streaming-server/gss-rtsp.c
+++ b/gst-streaming-server/gss-rtsp.c
@@ -25,6 +25,12 @@
 #include <gst/gst.h>
 #include <gst/rtsp-server/rtsp-server.h>
 
+/**
+ * SECTION:gss-rtsp
+ * @short_description: Misc RTSP junk that's probably bitrotten
+ *
+ */
+
 
 void
 gss_server_rtsp_init (GssServer * server)
diff --git a/gst-streaming-server/gss-server.c b/gst-streaming-server/gss-server.c
index a91bd18..d76d14b 100644
--- a/gst-streaming-server/gss-server.c
+++ b/gst-streaming-server/gss-server.c
@@ -37,6 +37,12 @@
 
 #define GST_CAT_DEFAULT gss_debug
 
+/**
+ * SECTION:gss-server
+ * @short_description: Class that manages the HTTP server
+ *
+ */
+
 
 #define BASE "/"