[lasem] docs: some more documentation

[Emmanuel Pacaud <emmanuel src gnome org>]

commit 3913c269a21f1513f799d66d3121b0558ab98408
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Sun Feb 15 22:47:32 2015 +0100

    docs: some more documentation

 docs/reference/lasem/Makefile.am        |    2 +
 docs/reference/lasem/lasem-docs.xml     |   32 +++++++++++++++++++++---------
 docs/reference/lasem/lasem-sections.txt |   18 ++++++++--------
 src/lsmdomcharacterdata.c               |   17 ++++++++++++++++
 src/lsmdomdocument.c                    |   17 ++++++++++++++++
 5 files changed, 67 insertions(+), 19 deletions(-)
---
diff --git a/docs/reference/lasem/Makefile.am b/docs/reference/lasem/Makefile.am
index bb78680..75b668c 100644
--- a/docs/reference/lasem/Makefile.am
+++ b/docs/reference/lasem/Makefile.am
@@ -195,3 +195,5 @@ EXTRA_DIST +=
 # Files not to distribute
 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+
+#TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/lasem/lasem-docs.xml b/docs/reference/lasem/lasem-docs.xml
index 8b57f8e..54c2bec 100644
--- a/docs/reference/lasem/lasem-docs.xml
+++ b/docs/reference/lasem/lasem-docs.xml
@@ -48,16 +48,28 @@
                        <xi:include href="xml/lsmdomnamednodemap.xml"/>
                        <xi:include href="xml/lsmdomdocumentfragment.xml"/>
                </chapter>
-       </part>
 
-       <chapter id="object-tree">
-               <title>Object Hierarchy</title>
-               <xi:include href="xml/tree_index.sgml"/>
-       </chapter>
-       <index id="api-index-full">
-               <title>API Index</title>
-               <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-       </index>
+               <chapter id="object-tree">
+                       <title>Object Hierarchy</title>
+                       <xi:include href="xml/tree_index.sgml"/>
+               </chapter>
 
-       <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+       </part>
+
+       <part>
+               <title>Appendices</title>
+               <index id="api-index-full">
+                       <title>API Index</title>
+                       <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+               </index>
+               <index id="api-index-deprecated">
+                       <title>Index of deprecated symbols</title>
+                       <xi:include href="xml/api-index-deprecated.xml"><xi:fallback/></xi:include>
+               </index>
+               <index role="0.4">
+                       <title>Index of new symbols in 0.4</title>
+                       <xi:include href="xml/api-index-0.4.xml"><xi:fallback/></xi:include>
+               </index>
+               <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+       </part>
 </book>
diff --git a/docs/reference/lasem/lasem-sections.txt b/docs/reference/lasem/lasem-sections.txt
index 9e1d036..39a4f70 100644
--- a/docs/reference/lasem/lasem-sections.txt
+++ b/docs/reference/lasem/lasem-sections.txt
@@ -1,9 +1,9 @@
 <SECTION>
 <FILE>lsmdomtext</FILE>
 <TITLE>LsmDomText</TITLE>
-LsmDomText
 lsm_dom_text_new
 <SUBSECTION Standard>
+LsmDomText
 LsmDomTextClass
 LSM_DOM_TEXT
 LSM_IS_DOM_TEXT
@@ -17,7 +17,6 @@ LSM_DOM_TEXT_GET_CLASS
 <SECTION>
 <FILE>lsmdomnode</FILE>
 <TITLE>LsmDomNode</TITLE>
-LsmDomNode
 lsm_dom_node_get_node_name
 lsm_dom_node_get_node_value
 lsm_dom_node_set_node_value
@@ -37,6 +36,7 @@ lsm_dom_node_has_child_nodes
 lsm_dom_node_changed
 lsm_dom_node_get_owner_document
 <SUBSECTION Standard>
+LsmDomNode
 LsmDomNodeType
 LsmDomNodeClass
 LSM_DOM_NODE
@@ -90,7 +90,6 @@ lsm_dom_named_node_map_get_type
 <SECTION>
 <FILE>lsmdomdocument</FILE>
 <TITLE>LsmDomDocument</TITLE>
-LsmDomDocument
 LsmDomDocumentCreateFunction
 lsm_dom_implementation_create_document
 lsm_dom_implementation_cleanup
@@ -112,6 +111,7 @@ lsm_dom_document_set_path
 lsm_dom_document_get_href_data
 lsm_dom_get_entity
 <SUBSECTION Standard>
+LsmDomDocument
 LsmDomDocumentClass
 LSM_DOM_DOCUMENT
 LSM_IS_DOM_DOCUMENT
@@ -143,11 +143,11 @@ lsm_dom_document_fragment_get_type
 <SECTION>
 <FILE>lsmdomelement</FILE>
 <TITLE>LsmDomElement</TITLE>
-LsmDomElement
 lsm_dom_element_get_tag_name
 lsm_dom_element_get_attribute
 lsm_dom_element_set_attribute
 <SUBSECTION Standard>
+LsmDomElement
 LsmDomElementClass
 LSM_DOM_ELEMENT
 LSM_IS_DOM_ELEMENT
@@ -161,10 +161,6 @@ LSM_DOM_ELEMENT_GET_CLASS
 <SECTION>
 <FILE>lsmdomview</FILE>
 <TITLE>LsmDomView</TITLE>
-LSM_DOM_VIEW_DEFAULT_RESOLUTION
-LSM_DOM_VIEW_DEFAULT_VIEWBOX_HEIGHT
-LSM_DOM_VIEW_DEFAULT_VIEWBOX_WIDTH
-LsmDomView
 lsm_dom_view_get_resolution
 lsm_dom_view_get_viewport
 lsm_dom_view_get_viewport_pixels
@@ -176,6 +172,7 @@ lsm_dom_view_get_size
 lsm_dom_view_get_size_pixels
 lsm_dom_view_set_debug
 <SUBSECTION Standard>
+LsmDomView
 LsmDomViewClass
 LSM_DOM_VIEW
 LSM_IS_DOM_VIEW
@@ -185,6 +182,9 @@ LSM_DOM_VIEW_CLASS
 LSM_IS_DOM_VIEW_CLASS
 LSM_DOM_VIEW_GET_CLASS
 <SUBSECTION Private>
+LSM_DOM_VIEW_DEFAULT_RESOLUTION
+LSM_DOM_VIEW_DEFAULT_VIEWBOX_HEIGHT
+LSM_DOM_VIEW_DEFAULT_VIEWBOX_WIDTH
 lsm_dom_view_set_document
 LSM_TYPE_BOX
 LSM_TYPE_EXTENTS
@@ -197,10 +197,10 @@ lsm_extents_get_type
 <SECTION>
 <FILE>lsmdomcharacterdata</FILE>
 <TITLE>LsmDomCharacterData</TITLE>
-LsmDomCharacterData
 lsm_dom_character_data_get_data
 lsm_dom_character_data_set_data
 <SUBSECTION Standard>
+LsmDomCharacterData
 LsmDomCharacterDataClass
 LSM_DOM_CHARACTER_DATA
 LSM_IS_DOM_CHARACTER_DATA
diff --git a/src/lsmdomcharacterdata.c b/src/lsmdomcharacterdata.c
index 69c1876..75d7002 100644
--- a/src/lsmdomcharacterdata.c
+++ b/src/lsmdomcharacterdata.c
@@ -57,6 +57,15 @@ lsm_dom_character_data_set_node_value (LsmDomNode* self, const char *value)
 
 /* LsmDomCharacterData implementation */
 
+/**
+ * lsm_dom_character_data_get_data:
+ * @self: a #LsmDomCharacterData
+ *
+ * Get the character node data.
+ *
+ * Return value: character node data.
+ */
+
 const char *
 lsm_dom_character_data_get_data (LsmDomCharacterData* self)
 {
@@ -65,6 +74,14 @@ lsm_dom_character_data_get_data (LsmDomCharacterData* self)
        return self->data;
 }
 
+/**
+ * lsm_dom_character_data_set_data:
+ * @self: a #LsmDomCharacterData
+ * @value: new node data
+ *
+ * Set the character node data.
+ */
+
 void
 lsm_dom_character_data_set_data (LsmDomCharacterData* self, const char * value)
 {
diff --git a/src/lsmdomdocument.c b/src/lsmdomdocument.c
index f112e51..8921558 100644
--- a/src/lsmdomdocument.c
+++ b/src/lsmdomdocument.c
@@ -57,6 +57,8 @@ lsm_dom_document_get_node_type (LsmDomNode *node)
  * lsm_dom_document_get_document_element:
  * @self: a #LsmDomElement
  *
+ * Get the child node that is the root element of the document.
+ *
  * Returns: (transfer none): document element
  */
 
@@ -73,6 +75,8 @@ lsm_dom_document_get_document_element (LsmDomDocument *self)
  * @self: a #LsmDomDocument
  * @tag_name: name of the element to create
  *
+ * Create a new element node with a type corresponding to @tag_name.
+ *
  * Returns: (transfer full): a newly created #LsmDomElement
  */
 
@@ -113,6 +117,8 @@ lsm_dom_document_create_text_node_base (LsmDomDocument *document, const char *da
  * @self: a #LsmDomDocument
  * @data: content of the text node
  *
+ * Create a text node with @data as its initial content.
+ *
  * Returns: (transfer full): a newly created #LsmDomText
  */
 
@@ -128,6 +134,8 @@ lsm_dom_document_create_text_node (LsmDomDocument *document, const char *data)
  * lsm_dom_document_create_view:
  * @self: a #LsmDomDocument
  *
+ * Create a #LsmDomView for document rendering.
+ *
  * Returns: (transfer full): a new #LsmDomView
  */
 
@@ -139,6 +147,15 @@ lsm_dom_document_create_view (LsmDomDocument *self)
        return LSM_DOM_DOCUMENT_GET_CLASS (self)->create_view (self);
 }
 
+/**
+ * lsm_dom_document_get_url:
+ * @self: a #LsmDomDocument
+ *
+ * Get document URL.
+ *
+ * Return value: document URL.
+ */
+
 const char *
 lsm_dom_document_get_url (LsmDomDocument *self)
 {