Document GisData

[grits] / src / data / gis-data.c

diff --git a/src/data/gis-data.c b/src/data/gis-data.c
index db3b16e1d6cb6e21e4664fcce28cee6df8b4c45e..1126825be09342eb54d138ff330d35be5e5f8611 100644 (file)
--- a/src/data/gis-data.c
+++ b/src/data/gis-data.c
@@ -15,14 +15,29 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * SECTION:gis-data
+ * @short_description: Miscellaneous utilities for data access
+ * @include: glib/gstdio.h
+ *
+ * Various support routines for data access,
+ * these are mostly related to disk caching.
+ */
+
 #include <config.h>
 #include <stdio.h>
 #include <glib.h>
 
 #include "gis-data.h"
 
-/*
+/**
+ * fopen_p:
+ * @path: the path to the file to be opened.
+ * @mode: mode to open the file, see <function>fopen</function> for details
+ *
  * Open a file, creating parent directories if needed
+ *
+ * Returns: the opened file descriptor
  */
 FILE *fopen_p(const gchar *path, const gchar *mode)
 {