[GRASS-SVN] r47237 - grass/trunk/lib/gis

[svn_grass at osgeo.org]

Author: martinl
Date: 2011-07-23 14:10:12 -0700 (Sat, 23 Jul 2011)
New Revision: 47237

Modified:
   grass/trunk/lib/gis/gisinit.c
Log:
gislib: update dox for gisinit.c


Modified: grass/trunk/lib/gis/gisinit.c
===================================================================
--- grass/trunk/lib/gis/gisinit.c	2011-07-23 19:45:18 UTC (rev 47236)
+++ grass/trunk/lib/gis/gisinit.c	2011-07-23 21:10:12 UTC (rev 47237)
@@ -1,19 +1,16 @@
+/*!
+  \file lib/gis/gisinit.c
+  
+  \brief GIS Library - Handles program initialization.
+  
+  (C) 2001-2008, 2011 by the GRASS Development Team
+  
+  This program is free software under the GNU General Public License
+  (>=v2). Read the file COPYING that comes with GRASS for details.
+  
+  \author GRASS GIS Development Team
+*/
 
-/**
- * \file gisinit.c
- * 
- * \brief GIS Library - Handles program initialization.
- *
- * (C) 2001-2008 by the GRASS Development Team
- *
- * This program is free software under the GNU General Public License
- * (>=v2). Read the file COPYING that comes with GRASS for details.
- *
- * \author GRASS GIS Development Team
- *
- * \date 2000-2008
- */
-
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -32,17 +29,14 @@
 static int initialized = 0; /** Is set when engine is initialized */
 static int gisinit(void);
 
-
-/**
- * \brief Initialize GRASS GIS engine.
- *
- * Initializes GIS engine and ensures a valid mapset is available.
- *
- * \param[in] pgm Program (module) name
- * \return always returns 0 on success
- * \return exit() is called on error
- */
-
+/*!
+  \brief Initialize GIS Library and ensures a valid mapset is available.
+  
+  \param pgm program (module) name
+  
+  \return always returns 0 on success
+  \return G_fatal_error() is called on error
+*/
 void G__gisinit(const char *version, const char *pgm)
 {
     const char *mapset;
@@ -74,14 +68,11 @@
 }
 
 
-/**
- * \brief Initialize GRASS GIS engine.
- *
- * Initializes GIS engine, but does not check for a valid mapset.
- *
- * \return
- */
-
+/*!
+  \brief Initialize GIS Library
+  
+  Initializes GIS engine, but does not check for a valid mapset.
+*/
 void G__no_gisinit(const char *version)
 {
     if (initialized)
@@ -95,12 +86,9 @@
 }
 
 
-/**
- * \brief Checks to see if GIS engine is initialized.
- *
- * \return
- */
-
+/*!
+  \brief Checks to see if GIS engine is initialized.
+*/
 void G__check_gisinit(void)
 {
     if (initialized)
@@ -126,6 +114,9 @@
     return 0;
 }
 
+/*!
+  \brief Initialize environment
+*/
 void G_init_all(void)
 {
     G__check_gisinit();