r17072 - gnucash/trunk/src/core-utils - Small adjustments to a few comment lines used for doxygen documentation.

Charles Day cedayiv at cvs.gnucash.org
Mon Apr 7 18:28:02 EDT 2008


Author: cedayiv
Date: 2008-04-07 18:28:02 -0400 (Mon, 07 Apr 2008)
New Revision: 17072
Trac: http://svn.gnucash.org/trac/changeset/17072

Modified:
   gnucash/trunk/src/core-utils/gnc-glib-utils.h
Log:
Small adjustments to a few comment lines used for doxygen documentation.


Modified: gnucash/trunk/src/core-utils/gnc-glib-utils.h
===================================================================
--- gnucash/trunk/src/core-utils/gnc-glib-utils.h	2008-04-07 01:48:57 UTC (rev 17071)
+++ gnucash/trunk/src/core-utils/gnc-glib-utils.h	2008-04-07 22:28:02 UTC (rev 17072)
@@ -30,7 +30,7 @@
 
     @{ */
 /** @file gnc-glib-utils.h
- *  @brief glib helper routines.
+ *  @brief GLib helper routines
  *  @author Copyright (C) 2006 David Hampton <hampton at employees.org>
  */
 
@@ -57,10 +57,12 @@
 
 /**
  * @brief Validates UTF-8 encoded text for use in GnuCash.
+ *
  * Validates the strict subset of UTF-8 that is valid XML text, as detailed in
  * http://www.w3.org/TR/REC-xml/#NT-Char linked from bug #346535.
  *
- * (copied from g_utf8_validate):
+ * <em>Copied from g_utf8_validate():</em>
+ *
  * Validates UTF-8 encoded text, where @a str is the text to validate; if
  * @a str is nul-terminated, then @a max_len can be -1, otherwise @a max_len
  * should be the number of bytes to validate. If @a end is non-%NULL, then the
@@ -107,9 +109,8 @@
 gchar *gnc_utf8_strip_invalid_strdup (const gchar* str);
 
 /**
- * @brief Converts a string from UTF-8 to the current locale.
- * Converts a string from UTF-8 to the encoding used for strings
- * in the current locale.
+ * @brief Converts a string from UTF-8 to the encoding used for
+ * strings in the current locale.
  *
  * This essentially is a wrapper for g_locale_from_utf8 that can
  * be swigified for use with Scheme to avoid adding a dependency
@@ -122,9 +123,8 @@
 gchar *gnc_locale_from_utf8(const gchar* str);
 
 /**
- * @brief Converts a string to UTF-8 from the current locale.
- * Converts a string to UTF-8 from the encoding used for strings
- * in the current locale.
+ * @brief Converts a string to UTF-8 from the encoding used for
+ * strings in the current locale.
  *
  * This essentially is a wrapper for g_locale_to_utf8 that can
  * be swigified for use with Scheme to avoid adding a dependency



More information about the gnucash-changes mailing list