libgsf r1046 - in trunk: . doc doc/tmpl gsf

[jody svn gnome org]

Author: jody
Date: Thu Feb 19 10:41:32 2009
New Revision: 1046
URL: http://svn.gnome.org/viewvc/libgsf?rev=1046&view=rev

Log:
2009-02-19  Jody Goldberg <jody gnome org>

	* gsf/gsf.h : document the members of timestamp to avoid gtk-doc
	  warnings.

	* gsf/gsf-timestamp.c (gsf_timestamp_from_string) : renamed from.
	(gsf_timestamp_parse) : here, and this is deprecated.


Modified:
   trunk/ChangeLog
   trunk/doc/gsf-sections.txt
   trunk/doc/tmpl/utils.sgml
   trunk/gsf/gsf-libxml.c
   trunk/gsf/gsf-timestamp.c
   trunk/gsf/gsf.h

Modified: trunk/doc/gsf-sections.txt
==============================================================================
--- trunk/doc/gsf-sections.txt	(original)
+++ trunk/doc/gsf-sections.txt	Thu Feb 19 10:41:32 2009
@@ -773,7 +773,7 @@
 gsf_timestamp_copy
 gsf_timestamp_free
 gsf_timestamp_as_string
-gsf_timestamp_parse
+gsf_timestamp_from_string
 gsf_timestamp_hash
 gsf_timestamp_equal
 gsf_value_set_timestamp
@@ -781,6 +781,8 @@
 <SUBSECTION Standard>
 GSF_TIMESTAMP_TYPE
 gsf_timestamp_get_type
+<SUBSECTION Deprecated>
+gsf_timestamp_parse
 
 <SUBSECTION GObject>
 gsf_doc_prop_swap_val

Modified: trunk/doc/tmpl/utils.sgml
==============================================================================
--- trunk/doc/tmpl/utils.sgml	(original)
+++ trunk/doc/tmpl/utils.sgml	Thu Feb 19 10:41:32 2009
@@ -587,16 +587,6 @@
 @Returns: 
 
 
-<!-- ##### FUNCTION gsf_timestamp_parse ##### -->
-<para>
-
-</para>
-
- spec: 
- stamp: 
- Returns: 
-
-
 <!-- ##### FUNCTION gsf_timestamp_hash ##### -->
 <para>
 
@@ -633,6 +623,16 @@
 @v: 
 
 
+<!-- ##### FUNCTION gsf_timestamp_parse ##### -->
+<para>
+
+</para>
+
+ spec: 
+ stamp: 
+ Returns: 
+
+
 <!-- ##### FUNCTION gsf_doc_prop_swap_val ##### -->
 <para>
 

Modified: trunk/gsf/gsf-libxml.c
==============================================================================
--- trunk/gsf/gsf-libxml.c	(original)
+++ trunk/gsf/gsf-libxml.c	Thu Feb 19 10:41:32 2009
@@ -259,7 +259,7 @@
 	default:
 		if (GSF_TIMESTAMP_TYPE == t) {
 			GsfTimestamp ts;
-			if (gsf_timestamp_parse (str, &ts)) {
+			if (gsf_timestamp_from_string (str, &ts)) {
 				gsf_value_set_timestamp (res, &ts);
 				break;
 			}

Modified: trunk/gsf/gsf-timestamp.c
==============================================================================
--- trunk/gsf/gsf-timestamp.c	(original)
+++ trunk/gsf/gsf-timestamp.c	Thu Feb 19 10:41:32 2009
@@ -111,7 +111,7 @@
 #endif
 
 /**
- * gsf_timestamp_parse :
+ * gsf_timestamp_from_string :
  * @spec : The string to parse
  * @stamp : #GsfTimestamp
  *
@@ -119,13 +119,12 @@
  * 	'YYYY-MM-DDThh:mm:ss'
  * and does no bounds checking.
  *
- * ICK ICK ICK
- * This routine should be called _from_sting.
+ * Since: 1.14.12
  *
  * Returns: %TRUE on success
  **/
 int
-gsf_timestamp_parse (char const *spec, GsfTimestamp *stamp)
+gsf_timestamp_from_string (char const *spec, GsfTimestamp *stamp)
 {
 	struct tm	tm;
 
@@ -148,6 +147,25 @@
 }
 
 /**
+ * gsf_timestamp_parse :
+ * @spec : The string to parse
+ * @stamp : #GsfTimestamp
+ *
+ * Very simple parser for time stamps.  Currently requires a format of
+ * 	'YYYY-MM-DDThh:mm:ss'
+ * and does no bounds checking.
+ *
+ * Deprecated : Use gsf_timestamp_from_string
+ *
+ * Returns: %TRUE on success
+ **/
+int
+gsf_timestamp_parse (char const *spec, GsfTimestamp *stamp)
+{
+	return gsf_timestamp_from_string (spec, stamp);
+}
+
+/**
  * gsf_timestamp_as_string :
  * @stamp: timestamp to be converted.
  *

Modified: trunk/gsf/gsf.h
==============================================================================
--- trunk/gsf/gsf.h	(original)
+++ trunk/gsf/gsf.h	Thu Feb 19 10:41:32 2009
@@ -71,8 +71,12 @@
 
 /**
  * GsfTimestamp:
+ * @date :	#GDate in local timezone
+ * @seconds :	#glong number of seconds since @date.
+ * @time_zone :	possibly blank #GString of the timezone
+ * @timet : as from mktime.
  *
- * Class representing a point in time.
+ * A point in time.
  */
 typedef struct _GsfTimestamp	GsfTimestamp;