grim/gplate

A ton of documentation updates. Back up to 100% symbol coverage.

2008-02-11, grim
d841559018a2
Parents 4464c1a04980
Children bf1885ce9627
A ton of documentation updates. Back up to 100% symbol coverage.
9 files changed, 199 insertions(+), 16 deletions(-)
  • +2 -0
    doc/gplate/gplate-decl-list.txt
  • +21 -12
    doc/gplate/gplate-decl.txt
  • +1 -0
    doc/gplate/gplate-docs.sgml
  • +13 -0
    doc/gplate/gplate-sections.txt
  • +28 -0
    doc/gplate/tmpl/gplate-config.sgml
  • +3 -4
    doc/gplate/tmpl/gplate-errors.sgml
  • +8 -0
    doc/gplate/tmpl/gplate-library.sgml
  • +65 -0
    doc/gplate/tmpl/gplate-template.sgml
  • +58 -0
    gplate/gplate-template.c
    • --- a/doc/gplate/gplate-decl-list.txt Mon Feb 11 03:44:52 2008 -0600
    +++ b/doc/gplate/gplate-decl-list.txt Mon Feb 11 03:59:52 2008 -0600
    @@ -38,6 +38,7 @@
    gplate_template_render_file
    gplate_template_first_tag
    gplate_template_last_tag
    +gplate_template_current_tag
    gplate_template_next_tag
    gplate_template_previous_tag
    gplate_template_nth_tag
    @@ -240,6 +241,7 @@
    gplate_library_lookup_function
    gplate_library_lookup_function_for_tag
    gplate_library_lookup_tag
    +gplate_library_get_default_tag
    gplate_library_tags_foreach
    </SECTION>
    --- a/doc/gplate/gplate-decl.txt Mon Feb 11 03:44:52 2008 -0600
    +++ b/doc/gplate/gplate-decl.txt Mon Feb 11 03:59:52 2008 -0600
    @@ -174,10 +174,11 @@
    GPlateTag *(*first_tag)(GPlateTemplate *tplate);
    GPlateTag *(*last_tag)(GPlateTemplate *tplate);
    + GPlateTag *(*current_tag)(GPlateTemplate *tplate);
    GPlateTag *(*next_tag)(GPlateTemplate *tplate);
    GPlateTag *(*previous_tag)(GPlateTemplate *tplate);
    - GPlateTag *(*nth_tag)(GPlateTemplate *tplate);
    - GPlateTag *(*nth_previous_tag)(GPlateTemplate *tplate);
    + GPlateTag *(*nth_tag)(GPlateTemplate *tplate, guint nth);
    + GPlateTag *(*nth_previous_tag)(GPlateTemplate *tplate, guint nth);
    void (*_gplate_reserved1)(void);
    void (*_gplate_reserved2)(void);
    @@ -222,6 +223,11 @@
    GPlateTemplate *tplate
    </FUNCTION>
    <FUNCTION>
    +<NAME>gplate_template_current_tag</NAME>
    +<RETURNS>GPlateTag *</RETURNS>
    +GPlateTemplate *tplate
    +</FUNCTION>
    +<FUNCTION>
    <NAME>gplate_template_next_tag</NAME>
    <RETURNS>GPlateTag *</RETURNS>
    GPlateTemplate *tplate
    @@ -234,12 +240,12 @@
    <FUNCTION>
    <NAME>gplate_template_nth_tag</NAME>
    <RETURNS>GPlateTag *</RETURNS>
    -GPlateTemplate *tplate
    +GPlateTemplate *tplate, guint nth
    </FUNCTION>
    <FUNCTION>
    <NAME>gplate_template_nth_previous_tag</NAME>
    <RETURNS>GPlateTag *</RETURNS>
    -GPlateTemplate *tplate
    +GPlateTemplate *tplate, guint nth
    </FUNCTION>
    <FUNCTION>
    <NAME>gplate_config_load_default</NAME>
    @@ -534,20 +540,18 @@
    GPLATE_ERROR_TYPE_IS_NOT_DESCENDANT = 100,
    GPLATE_ERROR_TYPE_IS_ABSTRACT,
    - GPLATE_ERROR_TAG_EXISTS = 210,
    - GPLATE_ERROR_TAG_FALL_THROUGH_EXISTS,
    - GPLATE_ERROR_TAG_NO_PREFIX_HAVE_SUFFIX = 220,
    - GPLATE_ERROR_TAG_HAVE_PREFIX_NO_SUFFIX,
    + GPLATE_ERROR_TEMPLATE_FILE_DOES_NOT_EXIST = 200,
    - GPLATE_ERROR_TEMPLATE_FILE_DOES_NOT_EXIST = 300,
    -
    - GPLATE_ERROR_LIBRARY_FUNCTION_NAME_EXISTS = 400,
    + GPLATE_ERROR_LIBRARY_FUNCTION_NAME_EXISTS = 300,
    GPLATE_ERROR_LIBRARY_FUNCTION_NAME_NOT_FOUND,
    GPLATE_ERROR_LIBRARY_FUNCTION_BOUND,
    GPLATE_ERROR_LIBRARY_FUNCTION_NOT_BOUND,
    GPLATE_ERROR_LIBRARY_FUNCTION_NOT_BOUND_TO_TAG,
    - GPLATE_ERROR_LIBRARY_TAG_EXISTS = 450,
    + GPLATE_ERROR_LIBRARY_TAG_EXISTS = 350,
    GPLATE_ERROR_LIBRARY_TAG_NOT_FOUND,
    + GPLATE_ERROR_LIBRARY_TAG_NO_PREFIX_HAVE_SUFFIX,
    + GPLATE_ERROR_LIBRARY_TAG_HAVE_PREFIX_NO_SUFFIX,
    + GPLATE_ERROR_LIBRARY_DEFAULT_TAG_REGISTERED = 360,
    GPLATE_ERROR_UNKNOWN = 1 << 31,
    } GPlateErrors;
    @@ -887,6 +891,11 @@
    GType tag, gchar **prefix, gchar **suffix, GError **error
    </FUNCTION>
    <FUNCTION>
    +<NAME>gplate_library_get_default_tag</NAME>
    +<RETURNS>GType </RETURNS>
    +void
    +</FUNCTION>
    +<FUNCTION>
    <NAME>gplate_library_tags_foreach</NAME>
    <RETURNS>void </RETURNS>
    GPlateLibraryTagsForeachFunc func, gpointer data
    --- a/doc/gplate/gplate-docs.sgml Mon Feb 11 03:44:52 2008 -0600
    +++ b/doc/gplate/gplate-docs.sgml Mon Feb 11 03:59:52 2008 -0600
    @@ -67,5 +67,6 @@
    <xi:include href="xml/gplate-library.xml"/>
    <xi:include href="xml/gplate-errors.xml"/>
    + <xi:include href="xml/gplate-config.xml"/>
    </part>
    </book>
    --- a/doc/gplate/gplate-sections.txt Mon Feb 11 03:44:52 2008 -0600
    +++ b/doc/gplate/gplate-sections.txt Mon Feb 11 03:59:52 2008 -0600
    @@ -21,6 +21,13 @@
    gplate_template_tokenize
    gplate_template_render
    gplate_template_render_file
    +gplate_template_first_tag
    +gplate_template_last_tag
    +gplate_template_current_tag
    +gplate_template_next_tag
    +gplate_template_previous_tag
    +gplate_template_nth_tag
    +gplate_template_nth_previous_tag
    <SUBSECTION Standard>
    GPLATE_TEMPLATE
    GPLATE_IS_TEMPLATE
    @@ -228,6 +235,7 @@
    gplate_library_lookup_function_for_tag
    gplate_library_lookup_tag
    gplate_library_tags_foreach
    +gplate_library_get_default_tag
    </SECTION>
    <SECTION>
    @@ -237,3 +245,8 @@
    gplate_errors_get_quark
    </SECTION>
    +<SECTION>
    +<FILE>gplate-config</FILE>
    +gplate_config_load_default
    +</SECTION>
    +
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/doc/gplate/tmpl/gplate-config.sgml Mon Feb 11 03:59:52 2008 -0600
    @@ -0,0 +1,28 @@
    +<!-- ##### SECTION Title ##### -->
    +Configuration
    +
    +<!-- ##### SECTION Short_Description ##### -->
    +API for loading custom configurations
    +
    +<!-- ##### SECTION Long_Description ##### -->
    +<para>
    +The config API is meant to be a simple simple way to load different tag sets.
    +</para>
    +
    +
    +<!-- ##### SECTION See_Also ##### -->
    +<para>
    +
    +</para>
    +
    +
    +<!-- ##### SECTION Stability_Level ##### -->
    +
    +
    +<!-- ##### FUNCTION gplate_config_load_default ##### -->
    +<para>
    +
    +</para>
    +
    +
    +
    --- a/doc/gplate/tmpl/gplate-errors.sgml Mon Feb 11 03:44:52 2008 -0600
    +++ b/doc/gplate/tmpl/gplate-errors.sgml Mon Feb 11 03:59:52 2008 -0600
    @@ -32,10 +32,6 @@
    @GPLATE_ERROR_TYPE_IS_NOT_DESCENDANT: Used when an ancestry check fails.
    @GPLATE_ERROR_TYPE_IS_ABSTRACT: Used when ancestry check requires a concrete class.
    -@GPLATE_ERROR_TAG_EXISTS: Used when a tag has already been added to a #GPlateTemplate.
    -@GPLATE_ERROR_TAG_FALL_THROUGH_EXISTS: Used when a fall through tag has already been added to a #GPlateTemplate.
    -@GPLATE_ERROR_TAG_NO_PREFIX_HAVE_SUFFIX: Used when a tag is being added to a #GPlateTemplate and the tag has a suffix, but not a prefix.
    -@GPLATE_ERROR_TAG_HAVE_PREFIX_NO_SUFFIX: Used when a tag is being added to a #GPlateTemplate and the tag has a prefix, but not a suffix.
    @GPLATE_ERROR_TEMPLATE_FILE_DOES_NOT_EXIST: Used when a #GPlateTemplate is trying to render a file, and the file does not exist.
    @GPLATE_ERROR_LIBRARY_FUNCTION_NAME_EXISTS: Used when a #GPlateFunction is added to the library when a #GPlateFunction has already been registered with the same name.
    @GPLATE_ERROR_LIBRARY_FUNCTION_NAME_NOT_FOUND: Used when a lookup fails.
    @@ -44,6 +40,9 @@
    @GPLATE_ERROR_LIBRARY_FUNCTION_NOT_BOUND_TO_TAG: Used when a #GPlateFunction is not bound to a specific #GPlateTag.
    @GPLATE_ERROR_LIBRARY_TAG_EXISTS: Used when a tag has already been registered in the library.
    @GPLATE_ERROR_LIBRARY_TAG_NOT_FOUND: Used when a lookup fails for a tag.
    +@GPLATE_ERROR_LIBRARY_TAG_NO_PREFIX_HAVE_SUFFIX: Used when a tag is registered and it does not have a prefix, but has a suffix.
    +@GPLATE_ERROR_LIBRARY_TAG_HAVE_PREFIX_NO_SUFFIX: Used when a tag is registered and it has a prefix, but does not have a suffix.
    +@GPLATE_ERROR_LIBRARY_DEFAULT_TAG_REGISTERED: Used when a default tag has already been registered.
    @GPLATE_ERROR_UNKNOWN: Undefined error.
    <!-- ##### FUNCTION gplate_errors_get_quark ##### -->
    --- a/doc/gplate/tmpl/gplate-library.sgml Mon Feb 11 03:44:52 2008 -0600
    +++ b/doc/gplate/tmpl/gplate-library.sgml Mon Feb 11 03:59:52 2008 -0600
    @@ -151,3 +151,11 @@
    @data:
    +<!-- ##### FUNCTION gplate_library_get_default_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@Returns:
    +
    +
    --- a/doc/gplate/tmpl/gplate-template.sgml Mon Feb 11 03:44:52 2008 -0600
    +++ b/doc/gplate/tmpl/gplate-template.sgml Mon Feb 11 03:59:52 2008 -0600
    @@ -65,3 +65,68 @@
    @Returns:
    +<!-- ##### FUNCTION gplate_template_first_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@tplate:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gplate_template_last_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@tplate:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gplate_template_current_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@tplate:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gplate_template_next_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@tplate:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gplate_template_previous_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@tplate:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gplate_template_nth_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@tplate:
    +@nth:
    +@Returns:
    +
    +
    +<!-- ##### FUNCTION gplate_template_nth_previous_tag ##### -->
    +<para>
    +
    +</para>
    +
    +@tplate:
    +@nth:
    +@Returns:
    +
    +
    --- a/gplate/gplate-template.c Mon Feb 11 03:44:52 2008 -0600
    +++ b/gplate/gplate-template.c Mon Feb 11 03:59:52 2008 -0600
    @@ -565,6 +565,14 @@
    return ret;
    }
    +/**
    + * gplate_template_first_tag:
    + * @tplate: The #GPlateTemplate.
    + *
    + * Moves the tag stack to the first tag and returns it.
    + *
    + * Return Value: The first tag or NULL.
    + */
    GPlateTag *
    gplate_template_first_tag(GPlateTemplate *tplate) {
    GPlateTemplateClass *klass = NULL;
    @@ -579,6 +587,14 @@
    return NULL;
    }
    +/**
    + * gplate_template_last_tag:
    + * @tplate: The #GPlateTemplate.
    + *
    + * Moves the tag stack to the last tag and returns it.
    + *
    + * Return Value: The last tag or NULL.
    + */
    GPlateTag *
    gplate_template_last_tag(GPlateTemplate *tplate) {
    GPlateTemplateClass *klass = NULL;
    @@ -593,6 +609,14 @@
    return NULL;
    }
    +/**
    + * gplate_template_current_tag:
    + * @tplate: The #GPlateTemplate.
    + *
    + * Returns the current tag.
    + *
    + * Return Value: The current tag or NULL.
    + */
    GPlateTag *
    gplate_template_current_tag(GPlateTemplate *tplate) {
    GPlateTemplateClass *klass = NULL;
    @@ -607,6 +631,14 @@
    return NULL;
    }
    +/**
    + * gplate_template_next_tag:
    + * @tplate: The #GPlateTemplate.
    + *
    + * Moves the tag stack forward one tag and returns it.
    + *
    + * Return Value: The previous tag or NULL.
    + */
    GPlateTag *
    gplate_template_next_tag(GPlateTemplate *tplate) {
    GPlateTemplateClass *klass = NULL;
    @@ -621,6 +653,14 @@
    return NULL;
    }
    +/**
    + * gplate_template_previous_tag:
    + * @tplate: The #GPlateTemplate.
    + *
    + * Moves the tag stack back one tag and returns it.
    + *
    + * Return Value: The previous tag or NULL.
    + */
    GPlateTag *
    gplate_template_previous_tag(GPlateTemplate *tplate) {
    GPlateTemplateClass *klass = NULL;
    @@ -635,6 +675,15 @@
    return NULL;
    }
    +/**
    + * gplate_template_nth_tag:
    + * @tplate: The #GPlateTemplate.
    + * @nth: The number of tags to move forwards.
    + *
    + * Moves the tag stack forward @nth tags and returns that tag.
    + *
    + * Return Value: The @nth tag or NULL.
    + */
    GPlateTag *
    gplate_template_nth_tag(GPlateTemplate *tplate, guint nth) {
    GPlateTemplateClass *klass = NULL;
    @@ -649,6 +698,15 @@
    return NULL;
    }
    +/**
    + * gplate_template_nth_previous_tag:
    + * @tplate: The #GPlateTemplate.
    + * @nth: The number of tags to move backwards.
    + *
    + * Moves the tag stack back @nth tags and returns that tag.
    + *
    + * Return Value: The @nth previous tag or NULL.
    + */
    GPlateTag *
    gplate_template_nth_previous_tag(GPlateTemplate *tplate, guint nth) {
    GPlateTemplateClass *klass = NULL;