grim/guifications3

removed all metions of opaque data structures from the object documentation and instead made sure there were three blank lines so gtk-doc doesn't think i want gibberish there
org.guifications.gf3
2009-08-03, Gary Kramlich
4c4f51980bed
Parents 0711a210fdb9
Children 093a309a9d84
removed all metions of opaque data structures from the object documentation and instead made sure there were three blank lines so gtk-doc doesn't think i want gibberish there
23 files changed, 24 insertions(+), 80 deletions(-)
  • +1 -3
    gflib/doc/gflib/tmpl/gf_client_connection.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_connection.sgml
  • +1 -4
    gflib/doc/gflib/tmpl/gf_console_logger.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_dispatcher.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_event.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_event_info.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_feed.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_feed_pool.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_file_logger.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_hash.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_image.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_logger.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_named_object.sgml
  • +1 -7
    gflib/doc/gflib/tmpl/gf_native_plugin.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_native_plugin_loader.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_object.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_plugin.sgml
  • +2 -8
    gflib/doc/gflib/tmpl/gf_plugin_loader.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_preference_engine.sgml
  • +1 -4
    gflib/doc/gflib/tmpl/gf_preference_engine_null.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_preference_engine_xml.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gf_server_connection.sgml
  • +1 -3
    gflib/doc/gflib/tmpl/gflib-unused.sgml
    • --- a/gflib/doc/gflib/tmpl/gf_client_connection.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_client_connection.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -19,9 +19,7 @@
    <!-- ##### STRUCT GfClientConnection ##### -->
    -<para>
    -#GfClientConnection is an opaque structure and should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_client_connection_connect ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_connection.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_connection.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfConnection ##### -->
    -<para>
    - #GfConnection is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfConnection::connected ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_console_logger.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_console_logger.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -21,10 +21,7 @@
    <!-- ##### STRUCT GfConsoleLogger ##### -->
    -<para>
    - #GfConsoleLogger is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### ARG GfConsoleLogger:ansicolor ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_dispatcher.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_dispatcher.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfDispatcher ##### -->
    -<para>
    - #GfDispatcher is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### USER_FUNCTION GfDispatcherEnumCallback ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_event.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_event.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfEvent ##### -->
    -<para>
    - #GfEvent is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfEvent:description ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_event_info.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_event_info.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -19,9 +19,7 @@
    <!-- ##### STRUCT GfEventInfo ##### -->
    -<para>
    - #GfEventInfo is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_event_info_new ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_feed.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_feed.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -35,9 +35,7 @@
    <!-- ##### STRUCT GfFeed ##### -->
    -<para>
    - #GfFeed is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfFeed::event-added ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_feed_pool.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_feed_pool.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -20,9 +20,7 @@
    <!-- ##### STRUCT GfFeedPool ##### -->
    -<para>
    - #GfFeedPool is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfFeedPool::registered-feed ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_file_logger.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_file_logger.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfFileLogger ##### -->
    -<para>
    - #GfFileLogger is an opaque data structure that should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfFileLogger:filename ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_hash.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_hash.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -19,9 +19,7 @@
    <!-- ##### STRUCT GfHash ##### -->
    -<para>
    - #GfHash is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_hash_init ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_image.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_image.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -20,9 +20,7 @@
    <!-- ##### STRUCT GfImage ##### -->
    -<para>
    - #GfImage is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_image_new_from_file ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_logger.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_logger.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfLogger ##### -->
    -<para>
    - #GfLogger is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfLogger:level ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_named_object.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_named_object.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfNamedObject ##### -->
    -<para>
    -#GfNamedObject is an opaque structure and should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_named_object_class_get_name ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_native_plugin.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_native_plugin.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -25,13 +25,7 @@
    <!-- ##### STRUCT GfNativePlugin ##### -->
    -<para>
    -</para>
    -@parent:
    -@_gf_reserved1:
    -@_gf_reserved2:
    -@_gf_reserved3:
    -@_gf_reserved4:
    +
    --- a/gflib/doc/gflib/tmpl/gf_native_plugin_loader.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_native_plugin_loader.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,8 +18,6 @@
    <!-- ##### STRUCT GfNativePluginLoader ##### -->
    -<para>
    - #GfNativePluginLoader is an opaque structure that should not be used directly.
    -</para>
    +
    --- a/gflib/doc/gflib/tmpl/gf_object.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_object.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -56,9 +56,7 @@
    @GF_OBJECT_RESERVED_4: Reserved.
    <!-- ##### STRUCT GfObject ##### -->
    -<para>
    - #GfObject is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfObject::destroy ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_plugin.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_plugin.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfPlugin ##### -->
    -<para>
    - #GfPlugin is an opaque structure and should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfPlugin:filename ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_plugin_loader.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_plugin_loader.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -19,17 +19,11 @@
    <!-- ##### STRUCT GfPluginLoader ##### -->
    -<para>
    - #GfPluginLoader is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### STRUCT GfPluginLoaderIface ##### -->
    -<para>
    - #GfPluginLoaderIface is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_plugin_loader_get_supported_extensions ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_preference_engine.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preference_engine.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -45,9 +45,7 @@
    @value: The value.
    <!-- ##### STRUCT GfPreferenceEngine ##### -->
    -<para>
    - #GfPreferenceEngine is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfPreferenceEngine::changed ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_preference_engine_null.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preference_engine_null.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -20,10 +20,7 @@
    <!-- ##### STRUCT GfPreferenceEngineNull ##### -->
    -<para>
    - #GfPreferenceEngineNull is an opaque structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_preference_engine_null_new ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_preference_engine_xml.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preference_engine_xml.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -19,9 +19,7 @@
    <!-- ##### STRUCT GfPreferenceEngineXML ##### -->
    -<para>
    - #GfPreferenceEngineXML is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfPreferenceEngineXML:filename ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_server_connection.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_server_connection.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfServerConnection ##### -->
    -<para>
    -#GfServerConnection is an opaque structure and should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_server_connection_listen ##### -->
    --- a/gflib/doc/gflib/tmpl/gflib-unused.sgml Mon Aug 03 01:10:43 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gflib-unused.sgml Mon Aug 03 01:31:04 2009 -0500
    @@ -709,9 +709,7 @@
    @blue: The blue value, 0-65535.
    <!-- ##### STRUCT GfColormap ##### -->
    -<para>
    - #GfColormap is an opaque structure that should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfConnection:type ##### -->