[GRASS-SVN] r42888 - grass/trunk/lib/raster

[svn_grass at osgeo.org]

Author: huhabla
Date: 2010-07-24 23:54:11 +0000 (Sat, 24 Jul 2010)
New Revision: 42888

Modified:
   grass/trunk/lib/raster/history.c
Log:
Doxygen documentation update.


Modified: grass/trunk/lib/raster/history.c
===================================================================
--- grass/trunk/lib/raster/history.c	2010-07-24 08:45:00 UTC (rev 42887)
+++ grass/trunk/lib/raster/history.c	2010-07-24 23:54:11 UTC (rev 42888)
@@ -17,12 +17,31 @@
 #include <grass/raster.h>
 #include <grass/glocale.h>
 
+/*!
+ * \brief Append a string to a History structure
+ *
+ *
+ * \param hist pointer to History structure which holds history info
+ * \param str string to append
+ *
+ * \return void
+ */
 void Rast_append_history(struct History *hist, const char *str)
 {
     hist->lines = G_realloc(hist->lines, (hist->nlines + 1) * sizeof(char *));
     hist->lines[hist->nlines++] = G_store(str);
 }
 
+/*!
+ * \brief Append a formated string to a History structure
+ *
+ *
+ * \param hist pointer to History structure which holds history info
+ * \param fmt a string of format characters
+ * \param ... the arguments associated with the format characters
+ *
+ * \return void
+ */
 void Rast_append_format_history(struct History *hist, const char *fmt, ...)
 {
     va_list ap;
@@ -145,11 +164,31 @@
     Rast__write_history(hist, fp);
 }
 
+
+/*!
+ * \brief Set the string of a specific history field
+ *
+ *
+ * \param hist pointer to History structure which holds history info
+ * \param field number of a specific history field, should be accessed with macros (HIST_MAPID, ...)
+ *
+ * \return string of the history field
+ */
 const char *Rast_get_history(struct History *hist, int field)
 {
     return hist->fields[field];
 }
 
+/*!
+ * \brief Set the string of a specific history field
+ *
+ *
+ * \param hist pointer to History structure which holds history info
+ * \param field number of a specific history field, should be accessed with macros (HIST_MAPID, ...)
+ * \param str string of the history field
+ *
+ * \return void
+ */
 void Rast_set_history(struct History *hist, int field, const char *str)
 {
     if (hist->fields[field])