grim/guifications3

a ton more documentation updates
org.guifications.gf3
2009-10-10, Gary Kramlich
6ba4348f432b
Parents 29f97e4bd552
Children c0306dd19a8d
a ton more documentation updates
11 files changed, 56 insertions(+), 81 deletions(-)
  • +7 -12
    gflib/doc/gflib/tmpl/gf_connection.sgml
  • +2 -2
    gflib/doc/gflib/tmpl/gf_feed_manager.sgml
  • +8 -8
    gflib/doc/gflib/tmpl/gf_log.sgml
  • +0 -7
    gflib/doc/gflib/tmpl/gf_native_plugin.sgml
  • +6 -6
    gflib/doc/gflib/tmpl/gf_object.sgml
  • +7 -14
    gflib/doc/gflib/tmpl/gf_plugin.sgml
  • +0 -9
    gflib/doc/gflib/tmpl/gf_plugin_loader.sgml
  • +7 -7
    gflib/doc/gflib/tmpl/gf_preference_engine.sgml
  • +4 -8
    gflib/doc/gflib/tmpl/gf_preferences_proxy.sgml
  • +3 -8
    gflib/doc/gflib/tmpl/gf_preferences_proxy_entry.sgml
  • +12 -0
    gflib/doc/gflib/tmpl/gflib-unused.sgml
    • --- a/gflib/doc/gflib/tmpl/gf_connection.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_connection.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -77,22 +77,17 @@
    </para>
    -<!-- ##### ARG GfConnection:state ##### -->
    +<!-- ##### ENUM GfConnectionState ##### -->
    <para>
    </para>
    -<!-- ##### ENUM GfConnectionState ##### -->
    -<para>
    - Valid connection states
    -</para>
    -
    -@GF_CONNECTION_STATE_UNKNOWN: Unknown
    -@GF_CONNECTION_STATE_DISCONNECTING: Disconnecting
    -@GF_CONNECTION_STATE_DISCONNECTED: Disconnected
    -@GF_CONNECTION_STATE_CONNECTING: Connecting
    -@GF_CONNECTION_STATE_CONNECTED: Connected
    -@GF_CONNECTION_STATES: Total States
    +@GF_CONNECTION_STATE_UNKNOWN:
    +@GF_CONNECTION_STATE_DISCONNECTING:
    +@GF_CONNECTION_STATE_DISCONNECTED:
    +@GF_CONNECTION_STATE_CONNECTING:
    +@GF_CONNECTION_STATE_CONNECTED:
    +@GF_CONNECTION_STATES:
    <!-- ##### FUNCTION gf_connection_set_state ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_feed_manager.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_feed_manager.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -2,11 +2,11 @@
    GfFeedManager
    <!-- ##### SECTION Short_Description ##### -->
    -
    +Feed Manager API
    <!-- ##### SECTION Long_Description ##### -->
    <para>
    -
    + The feed manager API is meant to simplify the management of feeds.
    </para>
    <!-- ##### SECTION See_Also ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_log.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_log.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -20,16 +20,16 @@
    <!-- ##### ENUM GfLogLevel ##### -->
    <para>
    - The different levels of logging.
    +
    </para>
    -@GF_LOG_LEVEL_UNKNOWN: Unknown.
    -@GF_LOG_LEVEL_VERBOSE: Logs everything.
    -@GF_LOG_LEVEL_INFO: Logs critical, warning, event and info entries.
    -@GF_LOG_LEVEL_EVENT: Logs critical, warning, and event entries.
    -@GF_LOG_LEVEL_WARNING: Logs critical and warning entries.
    -@GF_LOG_LEVEL_CRITICAL: Only logs critical entries.
    -@GF_LOG_LEVELS: Total levels.
    +@GF_LOG_LEVEL_UNKNOWN:
    +@GF_LOG_LEVEL_VERBOSE:
    +@GF_LOG_LEVEL_INFO:
    +@GF_LOG_LEVEL_EVENT:
    +@GF_LOG_LEVEL_WARNING:
    +@GF_LOG_LEVEL_CRITICAL:
    +@GF_LOG_LEVELS:
    <!-- ##### FUNCTION gf_log ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_native_plugin.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_native_plugin.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -22,19 +22,12 @@
    The current ABI version for all native plugins.
    </para>
    -
    -
    <!-- ##### STRUCT GfNativePlugin ##### -->
    <para>
    #GfNativePlugin is an opaque data structure and should not be used
    directly.
    </para>
    -@parent:
    -@_gf_reserved1:
    -@_gf_reserved2:
    -@_gf_reserved3:
    -@_gf_reserved4:
    <!-- ##### FUNCTION gf_native_plugin_add_interface ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_object.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_object.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -46,14 +46,14 @@
    <!-- ##### ENUM GfObjectFlags ##### -->
    <para>
    - Flags for #GfObject's
    +
    </para>
    -@GF_OBJECT_DESTROYING: The object is being destroyed.
    -@GF_OBJECT_RESERVED_1: Reserved.
    -@GF_OBJECT_RESERVED_2: Reserved.
    -@GF_OBJECT_RESERVED_3: Reserved.
    -@GF_OBJECT_RESERVED_4: Reserved.
    +@GF_OBJECT_DESTROYING:
    +@GF_OBJECT_RESERVED_1:
    +@GF_OBJECT_RESERVED_2:
    +@GF_OBJECT_RESERVED_3:
    +@GF_OBJECT_RESERVED_4:
    <!-- ##### STRUCT GfObject ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_plugin.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_plugin.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -33,24 +33,17 @@
    </para>
    -<!-- ##### ARG GfPlugin:state ##### -->
    +<!-- ##### ENUM GfPluginState ##### -->
    <para>
    </para>
    -<!-- ##### ENUM GfPluginState ##### -->
    -<para>
    - Possible states that a plugin could be in.
    -</para>
    -
    -@GF_PLUGIN_STATE_UNKNOWN: The plugin is in an unknow state.
    -@GF_PLUGIN_STATE_ERROR: Missing register function or some other error.
    -@GF_PLUGIN_STATE_LOADED: An instance of a type inplemented by this plugin is
    - allocated.
    -@GF_PLUGIN_STATE_LOAD_FAILED: Register function return FALSE.
    -@GF_PLUGIN_STATE_NOT_LOADED: There are no instances allocated of the types
    - implemented by this plugin.
    -@GF_PLUGIN_STATES: The total number of possible states for a plugin to be in.
    +@GF_PLUGIN_STATE_UNKNOWN:
    +@GF_PLUGIN_STATE_ERROR:
    +@GF_PLUGIN_STATE_LOADED:
    +@GF_PLUGIN_STATE_LOAD_FAILED:
    +@GF_PLUGIN_STATE_NOT_LOADED:
    +@GF_PLUGIN_STATES:
    <!-- ##### FUNCTION gf_plugin_get_filename ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_plugin_loader.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_plugin_loader.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -31,15 +31,6 @@
    directly.
    </para>
    -@gparent:
    -@supported_extensions:
    -@query:
    -@load:
    -@unload:
    -@_gf_reserved_1:
    -@_gf_reserved_2:
    -@_gf_reserved_3:
    -@_gf_reserved_4:
    <!-- ##### FUNCTION gf_plugin_loader_get_supported_extensions ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_preference_engine.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preference_engine.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -24,15 +24,15 @@
    <!-- ##### ENUM GfPreferenceType ##### -->
    <para>
    - The different valid types of a preference.
    +
    </para>
    -@GF_PREFERENCE_TYPE_UNKNOWN: Unknown.
    -@GF_PREFERENCE_TYPE_SECTION: Section.
    -@GF_PREFERENCE_TYPE_STRING: String.
    -@GF_PREFERENCE_TYPE_INT: Integer.
    -@GF_PREFERENCE_TYPE_BOOL: Boolean.
    -@GF_PREFERENCE_TYPES: Total Types.
    +@GF_PREFERENCE_TYPE_UNKNOWN:
    +@GF_PREFERENCE_TYPE_SECTION:
    +@GF_PREFERENCE_TYPE_STRING:
    +@GF_PREFERENCE_TYPE_INT:
    +@GF_PREFERENCE_TYPE_BOOL:
    +@GF_PREFERENCE_TYPES:
    <!-- ##### STRUCT GfPreference ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_preferences_proxy.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preferences_proxy.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -2,11 +2,13 @@
    GfPreferencesProxy
    <!-- ##### SECTION Short_Description ##### -->
    -
    +GfPreferencesProxy Object API
    <!-- ##### SECTION Long_Description ##### -->
    <para>
    -
    + The GfPreferencesProxy Object is a #GfPreferenceEngine that allows
    + additional #GfPreferenceEngine's to be added inside of the main preference
    + tree.
    </para>
    <!-- ##### SECTION See_Also ##### -->
    @@ -16,18 +18,12 @@
    <!-- ##### SECTION Stability_Level ##### -->
    -
    <!-- ##### STRUCT GfPreferencesProxy ##### -->
    <para>
    #GfPreferencesProxy is an opaque data structure and should not be used
    directly.
    </para>
    -@gparent:
    -@_gf_reserved1:
    -@_gf_reserved2:
    -@_gf_reserved3:
    -@_gf_reserved4:
    <!-- ##### FUNCTION gf_preferences_proxy_add_engine ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gf_preferences_proxy_entry.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preferences_proxy_entry.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -2,11 +2,12 @@
    GfPreferencesProxyEntry
    <!-- ##### SECTION Short_Description ##### -->
    -
    +GfPreferencesProxyEntry Object API
    <!-- ##### SECTION Long_Description ##### -->
    <para>
    -
    + #GfPreferencesProxyEntry is used by #GfPreferencesProxy to store the
    + individual #GfPreferenceEngine's and other data about them.
    </para>
    <!-- ##### SECTION See_Also ##### -->
    @@ -16,18 +17,12 @@
    <!-- ##### SECTION Stability_Level ##### -->
    -
    <!-- ##### STRUCT GfPreferencesProxyEntry ##### -->
    <para>
    #GfPreferencesProxyEntry is an opaque data structure and should not be used
    directly.
    </para>
    -@parent:
    -@_gf_reserved1:
    -@_gf_reserved2:
    -@_gf_reserved3:
    -@_gf_reserved4:
    <!-- ##### FUNCTION gf_preferences_proxy_entry_get_engine ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gflib-unused.sgml Sat Oct 10 18:47:52 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gflib-unused.sgml Sat Oct 10 23:01:08 2009 -0500
    @@ -210,6 +210,12 @@
    </para>
    +<!-- ##### ARG GfConnection:state ##### -->
    +<para>
    +
    +</para>
    +
    +
    <!-- ##### STRUCT GfDispatcher ##### -->
    @@ -250,6 +256,12 @@
    @feed_pool: The #GfFeedPool which received the signal.
    @feed: The #GfFeed that was unregistered.
    +<!-- ##### ARG GfPlugin:state ##### -->
    +<para>
    +
    +</para>
    +
    +
    <!-- ##### FUNCTION gf_connection_get_feed_pool ##### -->
    <para>