Re: [PATCH 4/6] doc: new gtk-doc files

[Simón Pena <spenap gmail com>]

On 29/09/10 20:43, Víctor Manuel Jáquez Leal wrote:
> grilo.types defines the GObject types defined in Grilo.
> 
> grilo-sections.txt defines the sections and their grouping elements.
> 
> Signed-off-by: Víctor Manuel Jáquez Leal <vjaquez igalia com>
> ---
>  doc/reference/grilo-sections.txt |  486 ++++++++++++++++++++++++++++++++++++++
>  doc/reference/grilo.types        |   21 ++
>  2 files changed, 507 insertions(+), 0 deletions(-)
>  create mode 100644 doc/reference/grilo-sections.txt
>  create mode 100644 doc/reference/grilo.types
> 
> diff --git a/doc/reference/grilo-sections.txt b/doc/reference/grilo-sections.txt
> new file mode 100644
> index 0000000..d6595f6
> --- /dev/null
> +++ b/doc/reference/grilo-sections.txt
> @@ -0,0 +1,486 @@
> +# Grilo API reference sections
> +
> +# please add sections in alphabetical order using the following template
> +# leave two empty lines between sections
> +# <SECTION>
> +# <FILE>grl-xxx</FILE>
> +# <TITLE>GrlXxx</TITLE>
> +# typedefs
> +# macros
> +# constructor
> +# methods
> +# <SUBSECTION Standard>
> +# <SUBSECTION Private>
> +# </SECTION>
> +
> +
> +<INCLUDE>grilo.h</INCLUDE>
> +
[...]
> +
> +<SECTION>
> +<FILE>grl-error</FILE>
> +<TITLE>GrlError</TITLE>
> +GRL_CORE_ERROR
> +GrlCoreError
> +</SECTION>
> +

A blank line at EOF is being introduced here

> diff --git a/doc/reference/grilo.types b/doc/reference/grilo.types
> new file mode 100644
> index 0000000..1a4886d
> --- /dev/null
> +++ b/doc/reference/grilo.types
> @@ -0,0 +1,21 @@
> +% add a _get_type for every GObject whose properties and signals you want
> +% documented
> +% add the relevant includes to be able to call those _get_type functions
> +
> +% adding a get_type here will:
> +% - change output file name from gstreamer-(whatever).html to (whatever).html
> +% - document properties and signals
> +
> +#include <grilo.h>
> +
> +grl_data_get_type
> +grl_config_get_type
> +grl_media_get_type
> +grl_media_box_get_type
> +grl_media_audio_get_type
> +grl_media_video_get_type
> +grl_media_image_get_type
> +grl_media_plugin_get_type
> +grl_media_source_get_type
> +grl_metadata_source_get_type
> +grl_plugin_registry_get_type