grim/guifications3

And we're back to a real 100% documentation coverage
org.guifications.gf3
2009-10-11, Gary Kramlich
e2fcbd5c8082
Parents 7e5b4b790338
Children c2b12623b1dc
And we're back to a real 100% documentation coverage
2 files changed, 56 insertions(+), 0 deletions(-)
  • +15 -0
    gflib/gflib/gf_client.c
  • +41 -0
    gflib/gflib/gf_type.c
    • --- a/gflib/gflib/gf_client.c Sun Oct 11 03:33:17 2009 -0500
    +++ b/gflib/gflib/gf_client.c Sun Oct 11 03:52:18 2009 -0500
    @@ -177,6 +177,13 @@
    return type;
    }
    +/**
    + * gf_client_set_connection:
    + * @client: The #GfClient instance.
    + * @connection: The #GfClientConnection instance.
    + *
    + * Set the #GfClientConnection for @client to use and manage.
    + */
    void
    gf_client_set_connection(GfClient *client, GfClientConnection *connection) {
    GfClientPrivate *priv = NULL;
    @@ -206,6 +213,14 @@
    g_object_notify(G_OBJECT(client), "connection");
    }
    +/**
    + * gf_client_get_connection:
    + * @client: The #GfClient instance.
    + *
    + * Get's the #GfClientConnection instance that @client is using.
    + *
    + * Return Value: The #GfClientConnection instance that @client is using.
    + */
    GfClientConnection *
    gf_client_get_connection(const GfClient *client) {
    GfClientPrivate *priv = NULL;
    --- a/gflib/gflib/gf_type.c Sun Oct 11 03:33:17 2009 -0500
    +++ b/gflib/gflib/gf_type.c Sun Oct 11 03:52:18 2009 -0500
    @@ -288,6 +288,16 @@
    return type;
    }
    +/**
    + * gf_type_parse_context_new:
    + * @parser: A #GfTypeParser.
    + * @data: user data to pass to the #GfTypeParser functions.
    + * @destroy_notify: A function to free @data.
    + *
    + * Creates a new #GfTypeParseContext using @parser.
    + *
    + * Return Value: The new #GfTypeParseContext.
    + */
    GfTypeParseContext *
    gf_type_parse_context_new(GfTypeParser *parser, gpointer data,
    GDestroyNotify destroy_notify)
    @@ -301,6 +311,13 @@
    NULL);
    }
    +/**
    + * gf_type_parse_context_parse:
    + * @ctx: The #GfTypeParseContext instance.
    + * @type: The #GType to start the parsing at.
    + *
    + * Parses through all types descending from @type as well as @type itself.
    + */
    void
    gf_type_parse_context_parse(GfTypeParseContext *ctx, GType type)
    {
    @@ -315,6 +332,14 @@
    klass->parse(ctx, type);
    }
    +/**
    + * gf_type_parse_context_get_parser:
    + * @ctx: The #GfTypeParseContext instance.
    + *
    + * Gets the #GfTypeParser used in @ctx.
    + *
    + * Return Value: The #GfTypeParser used in @ctx.
    + */
    GfTypeParser *
    gf_type_parse_context_get_parser(const GfTypeParseContext *ctx) {
    GfTypeParseContextPrivate *priv = NULL;
    @@ -326,6 +351,14 @@
    return priv->parser;
    }
    +/**
    + * gf_type_parse_context_get_user_data:
    + * @ctx: The #GfTypeParseContext instance.
    + *
    + * Gets the user data from @ctx.
    + *
    + * Return Value: The user data used from @ctx.
    + */
    gpointer
    gf_type_parse_context_get_user_data(const GfTypeParseContext *ctx) {
    GfTypeParseContextPrivate *priv = NULL;
    @@ -337,6 +370,14 @@
    return priv->data;
    }
    +/**
    + * gf_type_parse_context_get_destroy_notify:
    + * @ctx: The #GfTypeParseContext instance.
    + *
    + * Gets the destroy notify function from @ctx.
    + *
    + * Return Value: The destroy notify function from @ctx.
    + */
    GDestroyNotify
    gf_type_parse_context_get_destroy_notify(const GfTypeParseContext *ctx) {
    GfTypeParseContextPrivate *priv = NULL;