[Galago-commits] r2801 - in trunk/libgalago: . docs/reference docs/reference/tmpl

galago-commits at freedesktop.org galago-commits at freedesktop.org
Sat May 20 20:24:35 PDT 2006


Author: chipx86
Date: 2006-05-20 20:24:32 -0700 (Sat, 20 May 2006)
New Revision: 2801

Removed:
   trunk/libgalago/docs/reference/tmpl/galago-context-base.sgml
   trunk/libgalago/docs/reference/tmpl/galago-context-priv.sgml
   trunk/libgalago/docs/reference/tmpl/galago-private.sgml
Modified:
   trunk/libgalago/ChangeLog
   trunk/libgalago/docs/reference/libgalago-sections.txt
   trunk/libgalago/docs/reference/tmpl/galago-account.sgml
   trunk/libgalago/docs/reference/tmpl/galago-context.sgml
   trunk/libgalago/docs/reference/tmpl/galago-core.sgml
   trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml
   trunk/libgalago/docs/reference/tmpl/galago-image.sgml
   trunk/libgalago/docs/reference/tmpl/galago-object.sgml
   trunk/libgalago/docs/reference/tmpl/galago-person.sgml
   trunk/libgalago/docs/reference/tmpl/galago-presence.sgml
   trunk/libgalago/docs/reference/tmpl/galago-service.sgml
   trunk/libgalago/docs/reference/tmpl/galago-status.sgml
   trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml
Log:
- Get us down to 7 undocumented things (which really are documented...)
- Organize the documentation into a couple sections.


Modified: trunk/libgalago/ChangeLog
===================================================================
--- trunk/libgalago/ChangeLog	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/ChangeLog	2006-05-21 03:24:32 UTC (rev 2801)
@@ -1,3 +1,23 @@
+Sat May 20 20:23:48 PDT 2006  Christian Hammond <chipx86 at chipx86.com>
+
+	D docs/reference/tmpl/galago-context-base.sgml:
+	D docs/reference/tmpl/galago-context-priv.sgml:
+	D docs/reference/tmpl/galago-private.sgml:
+	* docs/reference/libgalago-sections.txt:
+	* docs/reference/tmpl/galago-account.sgml:
+	* docs/reference/tmpl/galago-context.sgml:
+	* docs/reference/tmpl/galago-core.sgml:
+	* docs/reference/tmpl/galago-dbus.sgml:
+	* docs/reference/tmpl/galago-image.sgml:
+	* docs/reference/tmpl/galago-object.sgml:
+	* docs/reference/tmpl/galago-person.sgml:
+	* docs/reference/tmpl/galago-presence.sgml:
+	* docs/reference/tmpl/galago-service.sgml:
+	* docs/reference/tmpl/galago-status.sgml:
+	* docs/reference/tmpl/libgalago-unused.sgml:
+	  - Get us down to 7 undocumented things (which really are documented...)
+	  - Organize the documentation into a couple sections.
+
 Sat May 20 19:56:19 PDT 2006  Christian Hammond <chipx86 at chipx86.com>
 
 	* docs/reference/libgalago-docs.sgml:

Modified: trunk/libgalago/docs/reference/libgalago-sections.txt
===================================================================
--- trunk/libgalago/docs/reference/libgalago-sections.txt	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/libgalago-sections.txt	2006-05-21 03:24:32 UTC (rev 2801)
@@ -1,20 +1,5 @@
 <SECTION>
-<FILE>galago-context-base</FILE>
-GalagoContextPrivate
-<TITLE>GalagoContext</TITLE>
-GalagoContext
-<SUBSECTION Standard>
-GALAGO_CONTEXT
-GALAGO_IS_CONTEXT
-GALAGO_TYPE_CONTEXT
-GALAGO_CONTEXT_CLASS
-GALAGO_IS_CONTEXT_CLASS
-GALAGO_CONTEXT_GET_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>galago-presence</FILE>
-GalagoPresencePrivate
 <TITLE>GalagoPresence</TITLE>
 GalagoPresence
 GALAGO_DBUS_PRESENCE_INTERFACE
@@ -48,8 +33,6 @@
 
 <SECTION>
 <FILE>galago-object</FILE>
-DBUS_API_SUBJECT_TO_CHANGE
-GalagoObjectPrivate
 <TITLE>GalagoObject</TITLE>
 GalagoObject
 GalagoObjectFlags
@@ -94,7 +77,6 @@
 
 <SECTION>
 <FILE>galago-person</FILE>
-GalagoPersonPrivate
 <TITLE>GalagoPerson</TITLE>
 GalagoPerson
 GALAGO_DBUS_PERSON_INTERFACE
@@ -130,7 +112,6 @@
 
 <SECTION>
 <FILE>galago-image</FILE>
-GalagoImagePrivate
 <TITLE>GalagoImage</TITLE>
 GalagoImage
 GALAGO_DBUS_IMAGE_INTERFACE
@@ -149,7 +130,6 @@
 
 <SECTION>
 <FILE>galago-status</FILE>
-GalagoStatusPrivate
 GalagoStatusType
 GALAGO_STATUS_ID_AVAILABLE
 GALAGO_STATUS_ID_AWAY
@@ -185,7 +165,6 @@
 <FILE>galago-core</FILE>
 GALAGO_DBUS_CORE_INTERFACE
 GALAGO_DBUS_CORE_OBJECT
-GalagoCorePrivate
 GalagoInitFlags
 <TITLE>GalagoCore</TITLE>
 GalagoCore
@@ -222,7 +201,6 @@
 
 <SECTION>
 <FILE>galago-account</FILE>
-GalagoAccountPrivate
 <TITLE>GalagoAccount</TITLE>
 GalagoAccount
 GALAGO_DBUS_ACCOUNT_INTERFACE
@@ -254,7 +232,6 @@
 
 <SECTION>
 <FILE>galago-service</FILE>
-GalagoServicePrivate
 GalagoServiceFlags
 <TITLE>GalagoService</TITLE>
 GalagoService
@@ -351,7 +328,7 @@
 <SECTION>
 <TITLE>GalagoContext</TITLE>
 <FILE>galago-context</FILE>
-galago_context_get_type
+GalagoContext
 galago_context_new
 galago_context_push
 galago_context_pop
@@ -364,12 +341,20 @@
 galago_context_get_person_with_session_id
 galago_context_get_people
 galago_context_get_object
+<SUBSECTION Standard>
+galago_context_get_type
+GALAGO_CONTEXT
+GALAGO_IS_CONTEXT
+GALAGO_TYPE_CONTEXT
+GALAGO_CONTEXT_CLASS
+GALAGO_IS_CONTEXT_CLASS
+GALAGO_CONTEXT_GET_CLASS
+SECTION>
 </SECTION>
 
 <SECTION>
 <TITLE>D-BUS Utility Functions</TITLE>
 <FILE>galago-dbus</FILE>
-DBUS_API_SUBJECT_TO_CHANGE
 GALAGO_DBUS_SERVICE
 GALAGO_DBUS_ERROR_INVALID_ATTRIBUTE
 GALAGO_DBUS_ERROR_OBJECT_NOT_FOUND

Modified: trunk/libgalago/docs/reference/tmpl/galago-account.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-account.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-account.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -24,12 +24,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GalagoAccountPrivate ##### -->
-<para>
-Private data belonging to a person.
-</para>
-
-
 <!-- ##### STRUCT GalagoAccount ##### -->
 <para>
 This is an opaque structure representing an account. This should not be used

Deleted: trunk/libgalago/docs/reference/tmpl/galago-context-base.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-context-base.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-context-base.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -1,31 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GalagoContext
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GalagoContextPrivate ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### STRUCT GalagoContext ##### -->
-<para>
-
-</para>
-
-

Deleted: trunk/libgalago/docs/reference/tmpl/galago-context-priv.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-context-priv.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-context-priv.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-galago-context-priv
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-

Modified: trunk/libgalago/docs/reference/tmpl/galago-context.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-context.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-context.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -19,14 +19,13 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### FUNCTION galago_context_get_type ##### -->
+<!-- ##### STRUCT GalagoContext ##### -->
 <para>
-
+This is an opaque structure representing a context. This should not be used
+directly. Use the accessor functions below.
 </para>
 
- at Returns: 
 
-
 <!-- ##### FUNCTION galago_context_new ##### -->
 <para>
 

Modified: trunk/libgalago/docs/reference/tmpl/galago-core.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-core.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-core.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -38,12 +38,6 @@
 
 
 
-<!-- ##### STRUCT GalagoCorePrivate ##### -->
-<para>
-Private data belonging to a #GalagoCore.
-</para>
-
-
 <!-- ##### ENUM GalagoInitFlags ##### -->
 <para>
 Initialization flags passed to galago_init().

Modified: trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-dbus.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -19,13 +19,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### MACRO DBUS_API_SUBJECT_TO_CHANGE ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### MACRO GALAGO_DBUS_SERVICE ##### -->
 <para>
 The Galago D-BUS service.

Modified: trunk/libgalago/docs/reference/tmpl/galago-image.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-image.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-image.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -19,12 +19,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GalagoImagePrivate ##### -->
-<para>
-Private data belonging to a #GalagoImage.
-</para>
-
-
 <!-- ##### STRUCT GalagoImage ##### -->
 <para>
 This is an opaque structure representing an image. This should not be used

Modified: trunk/libgalago/docs/reference/tmpl/galago-object.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-object.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-object.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -30,19 +30,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### MACRO DBUS_API_SUBJECT_TO_CHANGE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### STRUCT GalagoObjectPrivate ##### -->
-<para>
-Private data belonging to an object.
-</para>
-
-
 <!-- ##### STRUCT GalagoObject ##### -->
 <para>
 The object itself. You should never access the members of this directly. Always

Modified: trunk/libgalago/docs/reference/tmpl/galago-person.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-person.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-person.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -27,12 +27,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GalagoPersonPrivate ##### -->
-<para>
-Private data belonging to a #GalagoPerson.
-</para>
-
-
 <!-- ##### STRUCT GalagoPerson ##### -->
 <para>
 This is an opaque structure representing a person. This should not be used

Modified: trunk/libgalago/docs/reference/tmpl/galago-presence.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-presence.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-presence.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -18,12 +18,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GalagoPresencePrivate ##### -->
-<para>
-Private data belonging to a #GalagoPresence.
-</para>
-
-
 <!-- ##### STRUCT GalagoPresence ##### -->
 <para>
 This is an opaque structure representing a presence. This should not be used

Deleted: trunk/libgalago/docs/reference/tmpl/galago-private.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-private.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-private.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -1,19 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-galago-private
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-

Modified: trunk/libgalago/docs/reference/tmpl/galago-service.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-service.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-service.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -27,12 +27,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GalagoServicePrivate ##### -->
-<para>
-Private data belonging to a #GalagoAccount.
-</para>
-
-
 <!-- ##### ENUM GalagoServiceFlags ##### -->
 <para>
 A list of flags specifying rules for the service. Currently this consists

Modified: trunk/libgalago/docs/reference/tmpl/galago-status.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/galago-status.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/galago-status.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -24,12 +24,6 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### STRUCT GalagoStatusPrivate ##### -->
-<para>
-Private data belonging to a #GalagoStatus.
-</para>
-
-
 <!-- ##### ENUM GalagoStatusType ##### -->
 <para>
 A type of status primitive. These are the most common ways to describe a

Modified: trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml
===================================================================
--- trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml	2006-05-21 02:56:33 UTC (rev 2800)
+++ trunk/libgalago/docs/reference/tmpl/libgalago-unused.sgml	2006-05-21 03:24:32 UTC (rev 2801)
@@ -1,72 +0,0 @@
-<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Stability_Level ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/GalagoKeyValue.sgml:Title ##### -->
-GalagoKeyValue
-
-
-<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Stability_Level ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/galago-context-priv.sgml:Title ##### -->
-galago-context-priv
-
-
-<!-- ##### SECTION ./tmpl/galago-private.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/galago-private.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/galago-private.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/galago-private.sgml:Stability_Level ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/galago-private.sgml:Title ##### -->
-galago-private
-
-



More information about the galago-commits mailing list