Re: [PATCH core 08/10] wc: gtkdoc documentation

[Simón Pena Placer <spenap gmail com>]

Besides the element-type annotation I mentioned yesterday, there're a
couple of typos

2010/10/4 Víctor Manuel Jáquez Leal <vjaquez igalia com>:
> Signed-off-by: Víctor Manuel Jáquez Leal <vjaquez igalia com>
> ---
>  libs/net/grl-net-wc.c |   77 +++++++++++++++++++++++++++++++++++++++++++++++++
>  libs/net/grl-net-wc.h |   23 ++++++++++++++
>  2 files changed, 100 insertions(+), 0 deletions(-)
>
> diff --git a/libs/net/grl-net-wc.c b/libs/net/grl-net-wc.c
> index 0d45e66..c4ce7d0 100644
> --- a/libs/net/grl-net-wc.c
> +++ b/libs/net/grl-net-wc.c
> @@ -22,6 +22,15 @@
>  *
>  */
>
> +/**
> + * SECTION:grl-net-wc
> + * @short_description: small and simple HTTP client
> + *
> + * Most of the Grilo's sources need to access to web resources. The purpose of
> + * this utility class is to provide an thin and lean mechanism for those plugins
> + * to interact with those resources.
> + */

A* thin

>  #ifdef HAVE_CONFIG_H
>  #include "config.h"
>  #endif
> @@ -93,6 +102,11 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
>
>   g_type_class_add_private (klass, sizeof (GrlNetWcPrivate));
>
> +  /**
> +   * GrlNetWc::loglevel
> +   *
> +   * The log lever for HTTP connections. This value is used by libsoup.
> +   */
>   g_object_class_install_property (g_klass,
>                                    PROP_LOG_LEVEL,
>                                    g_param_spec_uint ("loglevel",
> @@ -102,6 +116,12 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
>                                                       G_PARAM_READWRITE |
>                                                       G_PARAM_STATIC_STRINGS));

The log level*

> +/**
> + * grl_net_wc_request_finish:
> + * @self: a #GrlNetWc instance
> + * @result: The result of the request
> + * @content: The contents of the resource
> + * @length: (allow-none): The length of the contents or %NULL if it is not
> + * needed
> + * @error: return location for a #GError, or %NULL
> + *
> + * Finishes an asynchronous load of the file's contents.
> + * The contents are placed in contents, and length is set to the size of the
> + * contents string.
> + *
> + * The content address will be invalidated at the next request. So if you
> + * want to keep it, please copy it into another address.
> + *
> + * Returns: %TRUE if the request was successfull. If %FALSE a error occurred.
> + */
>  gboolean
>  grl_net_wc_request_finish (GrlNetWc *self,
>                            GAsyncResult *result,
> @@ -437,6 +492,14 @@ end_func:
>   return ret;
>  }

If %FALSE an* error occurred

> +/**
> + * GrlNetWcClass:
> + * @parent_class: the parent class structure
> + *
> + * Grilo web client helper class.
> + *
> + * It's a simple a thin web client for be used by the sources.
> + */
>  struct _GrlNetWcClass {
>
>   GObjectClass parent_class;

It's a simple (and?) thin web client to be used by the sources