[Gnucash-changes] Fix function name.

[David Hampton]

Log Message:
-----------
 Fix function name.  Document functions.

Tags:
----
gnucash-gnome2-dev

Modified Files:
--------------
    gnucash/src/engine:
        gnc-date.c
        gnc-date.h

Revision Data
-------------
Index: gnc-date.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-date.h,v
retrieving revision 1.6.2.6
retrieving revision 1.6.2.7
diff -Lsrc/engine/gnc-date.h -Lsrc/engine/gnc-date.h -u -r1.6.2.6 -r1.6.2.7
--- src/engine/gnc-date.h
+++ src/engine/gnc-date.h
@@ -283,10 +283,25 @@
  */
 void qof_date_format_set(QofDateFormat df);
 
-/** DOCUMENT ME! */
+/** This function returns a strftime formatting string for printing an
+ *  all numeric date (e.g. 2005-09-14).  The string returned is based
+ *  upon the location specified.
+ *
+ *  @param df The date style (us, uk, iso, etc) that should be provided.
+ *
+ *  @return A formatting string that will print a date in the
+ *  requested style  */
 const gchar *qof_date_format_get_string(QofDateFormat df);
-/** DOCUMENT ME! */
-const gchar *qof_date_format_get_format(QofDateFormat df);
+
+/** This function returns a strftime formatting string for printing a
+ *  date using words and numbers (e.g. 2005-September-14).  The string
+ *  returned is based upon the location specified.
+ *
+ *  @param df The date style (us, uk, iso, etc) that should be provided.
+ *
+ *  @return A formatting string that will print a date in the
+ *  requested style  */
+const gchar *qof_date_text_format_get_string(QofDateFormat df);
 // @}
 
 /** dateSeparator
Index: gnc-date.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-date.c,v
retrieving revision 1.6.2.7
retrieving revision 1.6.2.8
diff -Lsrc/engine/gnc-date.c -Lsrc/engine/gnc-date.c -u -r1.6.2.7 -r1.6.2.8
--- src/engine/gnc-date.c
+++ src/engine/gnc-date.c
@@ -408,7 +408,7 @@
 
 Globals: dateFormat
 */
-const gchar *qof_date_format_get_format(QofDateFormat df)
+const gchar *qof_date_text_format_get_string(QofDateFormat df)
 {
   switch(df) {
    case QOF_DATE_FORMAT_US: