Finish doxygen conversion of documentation.

[gedcom-parse.git] / gom / header.c

diff --git a/gom/header.c b/gom/header.c
index 5dc6b9f99cacadeb392032e6005115738c4b857e..ff67c35ab4483f3dd838ce47fd07ad6fff6f47a1 100644 (file)
--- a/gom/header.c
+++ b/gom/header.c
@@ -39,6 +39,22 @@ Gedcom_ctxt head_start(_REC_PARAMS_)
   return (Gedcom_ctxt) MAKE_GOM_CTXT(rec, header, &gom_header);
 }
 
+/** This function updates the timestamp of the header.
+
+    \param t  The time_t value giving the wanted timestamp
+
+    \retval 0 on success
+    \retval nonzero on errors
+*/
+int gom_header_update_timestamp(time_t t)
+{
+  int result = 0;
+  struct tm *tm_ptr = localtime(&t);
+  result |= update_date(&gom_header.date, tm_ptr);
+  result |= update_time(&gom_header.time, tm_ptr);
+  return result;
+}
+
 DEFINE_STRING_CB(header, head_sour_start, source.id)
 DEFINE_STRING_CB(header, head_sour_name_start, source.name)
 DEFINE_STRING_CB(header, head_sour_vers_start, source.version)
@@ -153,15 +169,6 @@ struct header* gom_get_header()
   return &gom_header;
 }
 
-int gom_header_update_timestamp(time_t t)
-{
-  int result = 0;
-  struct tm *tm_ptr = localtime(&t);
-  result |= update_date(&gom_header.date, tm_ptr);
-  result |= update_time(&gom_header.time, tm_ptr);
-  return result;
-}
-
 int write_header(Gedcom_write_hndl hndl)
 {
   int result = 0;