2007-12-08 Jim Evins <evins@snaught.com>

	* docs/libglabels/libglabels-decl-list.txt:
	* docs/libglabels/libglabels-docs.sgml:
	* docs/libglabels/libglabels-sections.txt:
	* docs/libglabels/libglabels-undocumented.txt:
	* docs/libglabels/tmpl/db.sgml:
	* docs/libglabels/tmpl/str.sgml:
	* libglabels/str.c:
		Documentation cleanup for libglabels.

git-svn-id: https://glabels.svn.sourceforge.net/svnroot/glabels/trunk@699 f5e0f49d-192f-0410-a22d-a8d8700d0965

diff --git a/glabels2/ChangeLog b/glabels2/ChangeLog
index cc133c0c6313fc3115864c6ef3a97a6b031aed7e..546aed21f251c590177982a8583311d34bec9f97 100644 (file)
--- a/glabels2/ChangeLog
+++ b/glabels2/ChangeLog
@@ -1,3 +1,14 @@
+2007-12-08  Jim Evins  <evins@snaught.com>
+
+       * docs/libglabels/libglabels-decl-list.txt:
+       * docs/libglabels/libglabels-docs.sgml:
+       * docs/libglabels/libglabels-sections.txt:
+       * docs/libglabels/libglabels-undocumented.txt:
+       * docs/libglabels/tmpl/db.sgml:
+       * docs/libglabels/tmpl/str.sgml:
+       * libglabels/str.c:
+               Documentation cleanup for libglabels.
+
 2007-11-29  Jim Evins  <evins@snaught.com>
 
        * libglabels/db.h:

diff --git a/glabels2/docs/libglabels/libglabels-decl-list.txt b/glabels2/docs/libglabels/libglabels-decl-list.txt
index 6e99ec0ea9d05a0b59b85bafbe25e78806a194e8..d1dcf984d6def23c45f03dd4ae27ed690ac074db 100644 (file)
--- a/glabels2/docs/libglabels/libglabels-decl-list.txt
+++ b/glabels2/docs/libglabels/libglabels-decl-list.txt
@@ -25,6 +25,7 @@ lgl_db_get_brand_list
 lgl_db_free_brand_list
 lgl_db_register_template
 lgl_db_does_template_exist
+lgl_db_does_template_name_exist
 lgl_db_get_template_name_list_unique
 lgl_db_get_template_name_list_all
 lgl_db_free_template_name_list
@@ -75,6 +76,11 @@ lgl_xml_template_create_template_node
 lglUnitsType
 </SECTION>
 
+<SECTION>
+<FILE>str</FILE>
+lgl_str_utf8_casecmp
+</SECTION>
+
 <SECTION>
 <FILE>template</FILE>
 lglTemplate

diff --git a/glabels2/docs/libglabels/libglabels-docs.sgml b/glabels2/docs/libglabels/libglabels-docs.sgml
index 993afd011b149fa56cc53921b28cd288a38d4583..a4b5b38106385a6c674f6542eb76925c3d827cae 100644 (file)
--- a/glabels2/docs/libglabels/libglabels-docs.sgml
+++ b/glabels2/docs/libglabels/libglabels-docs.sgml
@@ -14,7 +14,6 @@
     <xi:include href="xml/template.xml"/>
     <xi:include href="xml/paper.xml"/>
     <xi:include href="xml/category.xml"/>
-    <xi:include href="xml/enums.xml"/>
   </chapter>
 
   <chapter>
@@ -25,4 +24,10 @@
     <xi:include href="xml/xml.xml"/>
   </chapter>
 
+  <chapter>
+    <title>Miscellaneous</title>
+    <xi:include href="xml/enums.xml"/>
+    <xi:include href="xml/str.xml"/>
+  </chapter>
+
 </book>

diff --git a/glabels2/docs/libglabels/libglabels-sections.txt b/glabels2/docs/libglabels/libglabels-sections.txt
index ac954e4dc19159dc3c1a4c0903fcb397085cf6e7..658d109cacf6371fdb4da5f489e240d86da7ae4d 100644 (file)
--- a/glabels2/docs/libglabels/libglabels-sections.txt
+++ b/glabels2/docs/libglabels/libglabels-sections.txt
@@ -31,6 +31,7 @@ lgl_db_free_brand_list
 <SUBSECTION Template Functions>
 lgl_db_register_template
 lgl_db_does_template_exist
+lgl_db_does_template_name_exist
 lgl_db_get_template_name_list_unique
 lgl_db_get_template_name_list_all
 lgl_db_free_template_name_list
@@ -126,12 +127,6 @@ lgl_category_dup
 lgl_category_free
 </SECTION>
 
-<SECTION>
-<FILE>enums</FILE>
-<INCLUDE>libglabels/enums.h</INCLUDE>
-lglUnitsType
-</SECTION>
-
 <SECTION>
 <FILE>xml-paper</FILE>
 <INCLUDE>libglabels/xml-paper.h</INCLUDE>
@@ -156,7 +151,6 @@ lgl_xml_template_parse_templates_doc
 lgl_xml_template_parse_template_node
 lgl_xml_template_write_templates_to_file
 lgl_xml_template_write_template_to_file
-lgl_xml_template_create_templates_doc
 lgl_xml_template_create_template_node
 </SECTION>
 
@@ -186,3 +180,15 @@ lgl_xml_get_node_content
 lgl_xml_set_default_units
 </SECTION>
 
+<SECTION>
+<FILE>enums</FILE>
+<INCLUDE>libglabels/enums.h</INCLUDE>
+lglUnitsType
+</SECTION>
+
+<SECTION>
+<FILE>str</FILE>
+<INCLUDE>libglabels/str.h</INCLUDE>
+lgl_str_utf8_casecmp
+</SECTION>
+

diff --git a/glabels2/docs/libglabels/libglabels-undocumented.txt b/glabels2/docs/libglabels/libglabels-undocumented.txt
index a1352226f6f5e9de788da79402d09c5ad595e3f1..d4b8b2f7f14bafc3a88c2f4d384872d8ee064c25 100644 (file)
--- a/glabels2/docs/libglabels/libglabels-undocumented.txt
+++ b/glabels2/docs/libglabels/libglabels-undocumented.txt
@@ -1,5 +1,5 @@
 99% symbol docs coverage.
-137 symbols documented.
+141 symbols documented.
 0 symbols incomplete.
 1 not documented.
 

diff --git a/glabels2/docs/libglabels/tmpl/db.sgml b/glabels2/docs/libglabels/tmpl/db.sgml
index eaacab3f8f0e6ae99b7a2d2e2f4eb99aee6d4f00..3d5d2de3568f52670ccc86f2c90d1ed9ac64a688 100644 (file)
--- a/glabels2/docs/libglabels/tmpl/db.sgml
+++ b/glabels2/docs/libglabels/tmpl/db.sgml
@@ -235,6 +235,15 @@ This enumeration defines a set of possible return values for lgl_db_register_tem
 @Returns: 
 
 
+<!-- ##### FUNCTION lgl_db_does_template_name_exist ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
 <!-- ##### FUNCTION lgl_db_get_template_name_list_unique ##### -->
 <para>
 

diff --git a/glabels2/docs/libglabels/tmpl/str.sgml b/glabels2/docs/libglabels/tmpl/str.sgml
new file mode 100644 (file)
index 0000000..53cbd3b
--- /dev/null
+++ b/glabels2/docs/libglabels/tmpl/str.sgml
@@ -0,0 +1,30 @@
+<!-- ##### SECTION Title ##### -->
+String Utility Functions
+
+<!-- ##### SECTION Short_Description ##### -->
+String utility functions provided by libglabels
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+This section defines string utility functions used by libglabels and of
+possible use to a user of libglabels.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION lgl_str_utf8_casecmp ##### -->
+<para>
+
+</para>
+
+@s1: 
+@s2: 
+@Returns: 
+
+

diff --git a/glabels2/libglabels/str.c b/glabels2/libglabels/str.c
index adf52f2bd9f97d166a3a14e6ab3cc30fa44659fe..7c1f59a68e9148768cf259a82cf74b205e70d669 100644 (file)
--- a/glabels2/libglabels/str.c
+++ b/glabels2/libglabels/str.c
@@ -48,6 +48,20 @@
 /* Functions.                                */
 /*===========================================*/
 
+/**
+ * lgl_str_utf8_casecmp:
+ * @s1: string to compare with s2.
+ * @s2: string to compare with s1.
+ *
+ * Compare two UTF-8 strings, ignoring the case of characters.
+ *
+ * This function should be used only on strings that are known to be encoded
+ * in UTF-8 or a compatible UTF-8 subset.
+ *
+ * Returns: 0 if the strings match, a negative value if s1 < s2,
+ *          or a positive value if s1 > s2.
+ *
+ */
 gint
 lgl_str_utf8_casecmp (const gchar *s1,
                       const gchar *s2)