Fixing up documentation and making it error if symbols are missing.

4 files changed, 110 insertions, 9 deletions

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index e2a02cd..67582f2 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -91,5 +91,12 @@ EXTRA_DIST += version.xml.in
 #DISTCLEANFILES +=
 
 # Comment this out if you want your docs-status tested during 'make check'
-#TESTS = $(GTKDOC_CHECK)
+TESTS = gtkdoc-in-srcdir
+
+gtkdoc-in-srcdir: Makefile.am
+	@echo "#!/bin/sh" > $@
+	@echo "cd \"$(srcdir)\"" >> $@
+	@echo "$(GTKDOC_CHECK)" >> $@
+	@chmod +x $@
+DISTCLEANFILES = gtkdoc-in-srcdir
 
diff --git a/docs/reference/libappindicator-sections.txt b/docs/reference/libappindicator-sections.txt
index d64f53a..b994297 100644
--- a/docs/reference/libappindicator-sections.txt
+++ b/docs/reference/libappindicator-sections.txt
@@ -15,6 +15,7 @@ AppIndicatorStatus
 AppIndicatorPrivate
 <TITLE>AppIndicator</TITLE>
 AppIndicator
+AppIndicatorClass
 app_indicator_get_type
 app_indicator_new
 app_indicator_set_status
diff --git a/src/libappindicator/app-indicator.c b/src/libappindicator/app-indicator.c
index 6f4a6fd..5c04819 100644
--- a/src/libappindicator/app-indicator.c
+++ b/src/libappindicator/app-indicator.c
@@ -549,7 +549,12 @@ category_from_enum (AppIndicatorCategory category)
         @icon_name: The icon name for this indicator
         @category: The category of indicator.
 
-        @returns: A pointer to a new #AppIndicator object.
+		Creates a new #AppIndicator setting the properties:
+		#AppIndicator::id with @id, #AppIndicator::category
+		with @category and #AppIndicator::icon-name with
+		@icon_name.
+
+        Return value: A pointer to a new #AppIndicator object.
  */
 AppIndicator *
 app_indicator_new (const gchar          *id,
@@ -566,8 +571,16 @@ app_indicator_new (const gchar          *id,
 }
 
 /**
+	app_indicator_get_type:
+
+	Generates or returns the unique #GType for #AppIndicator.
+
+	Return value: A unique #GType for #AppIndicator objects.
+*/
+
+/**
 	app_indicator_set_status:
-	@ci: The #AppIndicator object to use
+	@self: The #AppIndicator object to use
 	@status: The status to set for this indicator
 
 	Wrapper function for property #AppIndicator::status.
@@ -588,7 +601,7 @@ app_indicator_set_status (AppIndicator *self, AppIndicatorStatus status)
 
 /**
 	app_indicator_set_attention_icon:
-	@ci: The #AppIndicator object to use
+	@self: The #AppIndicator object to use
 	@icon_name: The name of the attention icon to set for this indicator
 
 	Wrapper function for property #AppIndicator::attention-icon.
@@ -614,6 +627,10 @@ app_indicator_set_attention_icon (AppIndicator *self, const gchar *icon_name)
         app_indicator_set_icon:
         @self: The #AppIndicator object to use
         @icon_name: The icon name to set.
+
+		Sets the default icon to use when the status is active but
+		not set to attention.  In most cases, this should be the
+		application icon for the program.
 **/
 void
 app_indicator_set_icon (AppIndicator *self, const gchar *icon_name)
@@ -735,6 +752,10 @@ setup_dbusmenu (AppIndicator *self)
         app_indicator_set_menu:
         @self: The #AppIndicator
         @menu: A #GtkMenu to set
+
+		Sets the menu that should be shown when the Application Indicator
+		is clicked on in the panel.  An application indicator will not
+		be rendered unless it has a menu.
 **/
 void
 app_indicator_set_menu (AppIndicator *self, GtkMenu *menu)
@@ -761,7 +782,7 @@ app_indicator_set_menu (AppIndicator *self, GtkMenu *menu)
 
 /**
 	app_indicator_get_id:
-	@ci: The #AppIndicator object to use
+	@self: The #AppIndicator object to use
 
 	Wrapper function for property #AppIndicator::id.
 
@@ -777,7 +798,7 @@ app_indicator_get_id (AppIndicator *self)
 
 /**
 	app_indicator_get_category:
-	@ci: The #AppIndicator object to use
+	@self: The #AppIndicator object to use
 
 	Wrapper function for property #AppIndicator::category.
 
@@ -793,7 +814,7 @@ app_indicator_get_category (AppIndicator *self)
 
 /**
 	app_indicator_get_status:
-	@ci: The #AppIndicator object to use
+	@self: The #AppIndicator object to use
 
 	Wrapper function for property #AppIndicator::status.
 
@@ -809,7 +830,7 @@ app_indicator_get_status (AppIndicator *self)
 
 /**
 	app_indicator_get_icon:
-	@ci: The #AppIndicator object to use
+	@self: The #AppIndicator object to use
 
 	Wrapper function for property #AppIndicator::icon-name.
 
@@ -825,7 +846,7 @@ app_indicator_get_icon (AppIndicator *self)
 
 /**
 	app_indicator_get_attention_icon:
-	@ci: The #AppIndicator object to use
+	@self: The #AppIndicator object to use
 
 	Wrapper function for property #AppIndicator::attention-icon-name.
 
diff --git a/src/libappindicator/app-indicator.h b/src/libappindicator/app-indicator.h
index 6a961fe..e966a49 100644
--- a/src/libappindicator/app-indicator.h
+++ b/src/libappindicator/app-indicator.h
@@ -34,6 +34,41 @@ License version 3 and version 2.1 along with this program.  If not, see
 
 G_BEGIN_DECLS
 
+/**
+	APP_INDICATOR_TYPE:
+
+	Get the #GType for a #AppIndicator.
+*/
+/**
+	APP_INDICATOR:
+	@obj: The object to convert
+
+	Safely convert a #GObject into an #AppIndicator.
+*/
+/**
+	APP_INDICATOR_CLASS:
+	@klass: #GObjectClass based class to convert.
+
+	Safely convert a #GObjectClass into a #AppIndicatorClass.
+*/
+/**
+	IS_APP_INDICATOR:
+	@obj: An #GObject to check
+
+	Checks to see if @obj is in the object hierarchy of #AppIndicator.
+*/
+/**
+	IS_APP_INDICATOR_CLASS:
+	@klass: An #GObjectClass to check
+
+	Checks to see if @klass is in the object class hierarchy of #AppIndicatorClass.
+*/
+/**
+	APP_INDICATOR_GET_CLASS:
+	@obj: A #GObject in the class hierarchy of #AppIndicator.
+
+	Gets a pointer to the #AppIndicatorClass for the object @obj.
+*/
 #define APP_INDICATOR_TYPE            (app_indicator_get_type ())
 #define APP_INDICATOR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), APP_INDICATOR_TYPE, AppIndicator))
 #define APP_INDICATOR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), APP_INDICATOR_TYPE, AppIndicatorClass))
@@ -41,6 +76,26 @@ G_BEGIN_DECLS
 #define IS_APP_INDICATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), APP_INDICATOR_TYPE))
 #define APP_INDICATOR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), APP_INDICATOR_TYPE, AppIndicatorClass))
 
+/**
+	APP_INDICATOR_SIGNAL_NEW_ICON:
+
+	String identifier for the #AppIndicator::new-icon signal.
+*/
+/**
+	APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON:
+
+	String identifier for the #AppIndicator::new-attention-icon signal.
+*/
+/**
+	APP_INDICATOR_SIGNAL_NEW_STATUS:
+
+	String identifier for the #AppIndicator::new-status signal.
+*/
+/**
+	APP_INDICATOR_SIGNAL_CONNECTION_CHANGED:
+
+	String identifier for the #AppIndicator::connection-changed signal.
+*/
 #define APP_INDICATOR_SIGNAL_NEW_ICON            "new-icon"
 #define APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON  "new-attention-icon"
 #define APP_INDICATOR_SIGNAL_NEW_STATUS          "new-status"
@@ -167,4 +222,21 @@ const gchar *                   app_indicator_get_attention_icon (AppIndicator *
 
 G_END_DECLS
 
+/**
+	SECTION:app-indicator
+	@short_description: An object to put application information
+		into the panel.
+	@stability: Unstable
+	@include: libappindicator/app-indicator.h
+
+	An application indicator is a way for an application to put
+	a menu into the panel on the user's screen.  This allows the
+	user to interact with the application even though it might
+	not be visible to the user at the time.  In most cases this
+	is not a good solution as there are other ways to inform the
+	user.  It should only be use if persistence is a desired
+	feature for the user (not for your marketing purpose of
+	having your logo in the panel).
+*/
+
 #endif