grim/guifications3

ignore all of the object structs again. After looking at the gtkdoc stuff for gtk itself, I realized 100% doc coverage from gtkdoc doesn't matter. They leave the structs undocumented and don't care, so we'll do the same.
org.guifications.gf3
2009-10-11, Gary Kramlich
d5db4a1ceb09
Parents cdbec4a2bbfc
Children 7e5b4b790338
ignore all of the object structs again. After looking at the gtkdoc stuff for gtk itself, I realized 100% doc coverage from gtkdoc doesn't matter. They leave the structs undocumented and don't care, so we'll do the same.
25 files changed, 29 insertions(+), 125 deletions(-)
  • +1 -3
    gflib/doc/gflib/tmpl/gf_client.sgml
  • +1 -4
    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_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_manager.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 -4
    gflib/doc/gflib/tmpl/gf_named_object.sgml
  • +1 -9
    gflib/doc/gflib/tmpl/gf_native_plugin.sgml
  • +2 -4
    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
  • +0 -19
    gflib/doc/gflib/tmpl/gf_plugin_loader.sgml
  • +1 -4
    gflib/doc/gflib/tmpl/gf_preference_engine_null.sgml
  • +1 -4
    gflib/doc/gflib/tmpl/gf_preference_engine_xml.sgml
  • +1 -9
    gflib/doc/gflib/tmpl/gf_preferences_proxy.sgml
  • +1 -9
    gflib/doc/gflib/tmpl/gf_preferences_proxy_entry.sgml
  • +1 -4
    gflib/doc/gflib/tmpl/gf_server_connection.sgml
  • +2 -15
    gflib/doc/gflib/tmpl/gf_type.sgml
  • +4 -0
    gflib/doc/gflib/tmpl/gflib-unused.sgml
    • --- a/gflib/doc/gflib/tmpl/gf_client.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_client.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,9 +19,7 @@
    <!-- ##### STRUCT GfClient ##### -->
    -<para>
    - #GfClient is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfClient:connection ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_client_connection.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_client_connection.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,10 +19,7 @@
    <!-- ##### STRUCT GfClientConnection ##### -->
    -<para>
    - #GfClientConnection is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_client_connection_connect ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_connection.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_connection.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfConnection ##### -->
    -<para>
    - #GfConnection is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfConnection::connected ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_console_logger.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_console_logger.sgml Sun Oct 11 02:55:51 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_event.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_event.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfEvent ##### -->
    -<para>
    - #GfEvent is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfEvent:description ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_event_info.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_event_info.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,9 +19,7 @@
    <!-- ##### STRUCT GfEventInfo ##### -->
    -<para>
    - #GfEventInfo is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_event_info_new ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_feed.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_feed.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -35,9 +35,7 @@
    <!-- ##### STRUCT GfFeed ##### -->
    -<para>
    - #GfFeed is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfFeed::event-added ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_feed_manager.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_feed_manager.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfFeedManager ##### -->
    -<para>
    - #GfFeedManager is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfFeedManager::registered-feed ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_file_logger.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_file_logger.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfFileLogger ##### -->
    -<para>
    - #GfFileLogger is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfFileLogger:filename ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_hash.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_hash.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,9 +19,7 @@
    <!-- ##### STRUCT GfHash ##### -->
    -<para>
    - #GfHash is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_hash_init ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_image.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_image.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -20,9 +20,7 @@
    <!-- ##### STRUCT GfImage ##### -->
    -<para>
    - #GfImage is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_image_new_from_file ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_logger.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_logger.sgml Sun Oct 11 02:55:51 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 Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_named_object.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,10 +18,7 @@
    <!-- ##### STRUCT GfNamedObject ##### -->
    -<para>
    - #GfNamedObject is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_named_object_class_get_name ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_native_plugin.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_native_plugin.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -25,16 +25,8 @@
    <!-- ##### 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_native_plugin_loader.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_native_plugin_loader.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfNativePluginLoader ##### -->
    -<para>
    - #GfNativePluginLoader is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    +
    --- a/gflib/doc/gflib/tmpl/gf_object.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_object.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -56,9 +56,7 @@
    @GF_OBJECT_RESERVED_4:
    <!-- ##### STRUCT GfObject ##### -->
    -<para>
    - #GfObject is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### SIGNAL GfObject::destroy ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_plugin.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_plugin.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,9 +18,7 @@
    <!-- ##### STRUCT GfPlugin ##### -->
    -<para>
    - #GfPlugin is an opaque data structure and should not be used directly.
    -</para>
    +
    <!-- ##### ARG GfPlugin:filename ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_plugin_loader.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_plugin_loader.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,27 +19,8 @@
    <!-- ##### 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>
    -
    -@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_null.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preference_engine_null.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -20,10 +20,7 @@
    <!-- ##### STRUCT GfPreferenceEngineNull ##### -->
    -<para>
    - #GfPreferenceEngineNull is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_preference_engine_null_new ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_preference_engine_xml.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preference_engine_xml.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,10 +19,7 @@
    <!-- ##### STRUCT GfPreferenceEngineXML ##### -->
    -<para>
    - #GfPreferenceEngineXML is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### ARG GfPreferenceEngineXML:filename ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_preferences_proxy.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preferences_proxy.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -20,16 +20,8 @@
    <!-- ##### 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 Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_preferences_proxy_entry.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,16 +19,8 @@
    <!-- ##### 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/gf_server_connection.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_server_connection.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -18,10 +18,7 @@
    <!-- ##### STRUCT GfServerConnection ##### -->
    -<para>
    - #GfServerConnection is an opaque data structure and should not be used
    - directly.
    -</para>
    +
    <!-- ##### FUNCTION gf_server_connection_listen ##### -->
    --- a/gflib/doc/gflib/tmpl/gf_type.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gf_type.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -19,25 +19,12 @@
    <!-- ##### STRUCT GfTypeParseContext ##### -->
    -<para>
    -
    -</para>
    -@parent:
    -@_gf_reserved_1:
    -@_gf_reserved_2:
    -@_gf_reserved_3:
    -@_gf_reserved_4:
    +
    <!-- ##### STRUCT GfTypeParser ##### -->
    -<para>
    -
    -</para>
    -@start_object:
    -@end_object:
    -@param:
    -@signal:
    +
    <!-- ##### FUNCTION gf_type_children ##### -->
    <para>
    --- a/gflib/doc/gflib/tmpl/gflib-unused.sgml Sun Oct 11 02:11:18 2009 -0500
    +++ b/gflib/doc/gflib/tmpl/gflib-unused.sgml Sun Oct 11 02:55:51 2009 -0500
    @@ -250,6 +250,10 @@
    @feed_pool: The #GfFeedPool which received the signal.
    @feed: The #GfFeed that was unregistered.
    +<!-- ##### STRUCT GfPluginLoaderIface ##### -->
    +
    +
    +
    <!-- ##### FUNCTION gf_connection_get_feed_pool ##### -->
    <para>