瀏覽代碼

libgis: minor doxygen header updates (backport)

git-svn-id: https://svn.osgeo.org/grass/grass/branches/releasebranch_7_0@63641 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 10 年之前
父節點
當前提交
5d95f34d7e
共有 58 個文件被更改,包括 129 次插入105 次删除
  1. 1 1
      lib/gis/adj_cellhd.c
  2. 1 1
      lib/gis/area.c
  3. 1 1
      lib/gis/area_ellipse.c
  4. 1 1
      lib/gis/area_poly1.c
  5. 1 1
      lib/gis/area_poly2.c
  6. 1 1
      lib/gis/area_sphere.c
  7. 4 4
      lib/gis/ascii_chk.c
  8. 3 3
      lib/gis/asprintf.c
  9. 2 2
      lib/gis/bres_line.c
  10. 2 2
      lib/gis/color_str.c
  11. 4 4
      lib/gis/commas.c
  12. 1 1
      lib/gis/date.c
  13. 2 2
      lib/gis/debug.c
  14. 4 4
      lib/gis/done_msg.c
  15. 1 1
      lib/gis/endian.c
  16. 1 1
      lib/gis/find_file.c
  17. 1 1
      lib/gis/find_rast.c
  18. 1 1
      lib/gis/find_vect.c
  19. 1 1
      lib/gis/geodist.c
  20. 1 1
      lib/gis/get_ellipse.c
  21. 1 1
      lib/gis/getl.c
  22. 1 1
      lib/gis/gisdbase.c
  23. 4 4
      lib/gis/is.c
  24. 2 2
      lib/gis/key_value4.c
  25. 3 3
      lib/gis/locale.c
  26. 1 1
      lib/gis/ls.c
  27. 1 1
      lib/gis/ls_filter.c
  28. 2 2
      lib/gis/mapset_msc.c
  29. 1 1
      lib/gis/myname.c
  30. 1 1
      lib/gis/open.c
  31. 1 1
      lib/gis/parser_interface.c
  32. 1 1
      lib/gis/pole_in_poly.c
  33. 1 1
      lib/gis/put_window.c
  34. 1 1
      lib/gis/radii.c
  35. 1 1
      lib/gis/remove.c
  36. 1 1
      lib/gis/rename.c
  37. 4 4
      lib/gis/rhumbline.c
  38. 2 2
      lib/gis/rotate.c
  39. 1 1
      lib/gis/short_way.c
  40. 3 3
      lib/gis/snprintf.c
  41. 3 3
      lib/gis/spawn.c
  42. 1 1
      lib/gis/timestamp.c
  43. 1 1
      lib/gis/trim_dec.c
  44. 1 1
      lib/gis/units.c
  45. 3 3
      lib/gis/user_config.c
  46. 3 3
      lib/gis/view.c
  47. 1 1
      lib/gis/whoami.c
  48. 4 4
      lib/gis/wind_2_box.c
  49. 1 1
      lib/gis/wind_format.c
  50. 2 2
      lib/gis/wind_in.c
  51. 4 4
      lib/gis/wind_limits.c
  52. 4 4
      lib/gis/wind_overlap.c
  53. 12 0
      lib/gis/worker.c
  54. 4 4
      lib/gis/wr_cellhd.c
  55. 4 4
      lib/gis/writ_zeros.c
  56. 12 0
      lib/gis/xdr.c
  57. 1 1
      lib/gis/zero.c
  58. 1 1
      lib/gis/zone.c

+ 1 - 1
lib/gis/adj_cellhd.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/adj_cellhd.c
+ * \file lib/gis/adj_cellhd.c
  *
  * \brief GIS Library - CELL header adjustment.
  *

+ 1 - 1
lib/gis/area.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/area.c
+ * \file lib/gis/area.c
  *
  * \brief GIS Library - Area calculation functions.
  *

+ 1 - 1
lib/gis/area_ellipse.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/area_ellipse.c
+ * \file lib/gis/area_ellipse.c
  *
  * \brief GIS Library - Ellipse area routines.
  *

+ 1 - 1
lib/gis/area_poly1.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/area_poly1.c
+ * \file lib/gis/area_poly1.c
  *
  * \brief GIS Library - Polygon area calculation routines.
  *

+ 1 - 1
lib/gis/area_poly2.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/area_poly2.c
+ * \file lib/gis/area_poly2.c
  *
  * \brief GIS Library - Planimetric polygon area calculation routines.
  *

+ 1 - 1
lib/gis/area_sphere.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/area_sphere.c
+ * \file lib/gis/area_sphere.c
  *
  * \brief GIS Library - Sphereical area calculation routines.
  *

+ 4 - 4
lib/gis/ascii_chk.c

@@ -1,17 +1,17 @@
 
-/**
- * \file ascii_chk.c
+/*!
+ * \file lib/gis/ascii_chk.c
  *
  * \brief GIS Library - Remove non-ascii characters
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <grass/gis.h>

+ 3 - 3
lib/gis/asprintf.c

@@ -1,6 +1,6 @@
 
-/**
- * \file asprintf.c
+/*!
+ * \file lib/gis/asprintf.c
  *
  * \brief GIS Library - GRASS implementation of asprintf().
  *
@@ -9,7 +9,7 @@
  * Rewritten by Glynn Clements, Sat, 6 Feb 2010
  * Assumes that vsnprintf() is available
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2002-2014 by the GRASS Development Team
  * (C) 2010 by Glynn Clements
  *
  * This program is free software under the GNU General Public License

+ 2 - 2
lib/gis/bres_line.c

@@ -1,9 +1,9 @@
 /*
- * \file gis/bres_line.c
+ * \file lib/gis/bres_line.c
  *
  * \brief GIS Library - Bresenham line routines.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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.

+ 2 - 2
lib/gis/color_str.c

@@ -1,9 +1,9 @@
 /*!
-   \file gis/color_str.c
+   \file lib/gis/color_str.c
 
    \brief GIS library - color management, named color to RGB triplet
 
-   (C) 2001-2008 by the GRASS Development Team
+   (C) 2001-2014 by the GRASS Development Team
 
    This program is free software under the 
    GNU General Public License (>=v2). 

+ 4 - 4
lib/gis/commas.c

@@ -1,17 +1,17 @@
 
-/**
- * \file commas.c
+/*!
+ * \file lib/gis/commas.c
  *
  * \brief GIS Library - Comma string functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <string.h>

+ 1 - 1
lib/gis/date.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/date.c
+ * \file lib/gis/date.c
  *
  * \brief GIS Library - Date functions.
  *

+ 2 - 2
lib/gis/debug.c

@@ -1,5 +1,5 @@
-/**
- * \file debug.c
+/*!
+ * \file lib/gis/debug.c
  *
  * \brief GIS Library - Debug functions.
  *

+ 4 - 4
lib/gis/done_msg.c

@@ -1,17 +1,17 @@
 
-/**
- * \file done_msg.c
+/*!
+ * \file lib/gis/done_msg.c
  *
  * \brief GIS Library - Done message functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <stdarg.h>

+ 1 - 1
lib/gis/endian.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/endian.c
+ * \file lib/gis/endian.c
  *
  * \brief GIS Library - Functions to determine architecture endian.
  *

+ 1 - 1
lib/gis/find_file.c

@@ -1,5 +1,5 @@
 /*!
-   \file gis/find_file.c
+   \file lib/gis/find_file.c
 
    \brief GIS library - Find GRASS data base files
 

+ 1 - 1
lib/gis/find_rast.c

@@ -1,5 +1,5 @@
 /*!
- * \file strings.c
+ * \file lib/gis/strings.c
  * 
  * \brief GIS Library - Find raster map
  *

+ 1 - 1
lib/gis/find_vect.c

@@ -1,5 +1,5 @@
 /*!
-  \file gis/find_vect.c
+  \file lib/gis/find_vect.c
   
   \brief GIS library - Find a vector map
   

+ 1 - 1
lib/gis/geodist.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/geodist.c
+ * \file lib/gis/geodist.c
  *
  * \brief GIS Library - Geodesic distance routines.
  *

+ 1 - 1
lib/gis/get_ellipse.c

@@ -1,5 +1,5 @@
 /*!
-  \file gis/get_ellipse.c
+  \file lib/gis/get_ellipse.c
 
   \brief GIS Library - Getting ellipsoid parameters from the database.
 

+ 1 - 1
lib/gis/getl.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/getl.c
+ * \file lib/gis/getl.c
  *
  * \brief GIS Library - Get line of text from file
  *

+ 1 - 1
lib/gis/gisdbase.c

@@ -1,5 +1,5 @@
 /*!
-   \file gis/gisdbase.c
+   \file lib/gis/gisdbase.c
 
    \brief GIS library - environment routines (gisdbase)
 

+ 4 - 4
lib/gis/is.c

@@ -1,17 +1,17 @@
 
-/**
- * \file is.c
+/*!
+ * \file lib/gis/is.c
  *
  * \brief GIS Library - Tests for file existence.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 2001-2008
+ * \date 2001-2014
  */
 
 #include <stdio.h>

+ 2 - 2
lib/gis/key_value4.c

@@ -1,9 +1,9 @@
 /*!
-   \file key_value4.c
+   \file lib/gis/key_value4.c
 
    \brief Key_Value management.
 
-   (C) 2001-2008 by the GRASS Development Team
+   (C) 2001-2014 by the GRASS Development Team
 
    This program is free software under the 
    GNU General Public License (>=v2). 

+ 3 - 3
lib/gis/locale.c

@@ -1,10 +1,10 @@
 
-/**
- * \file locale.c
+/*!
+ * \file lib/gis/locale.c
  *
  * \brief GIS Library - Functions to handle locale.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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.

+ 1 - 1
lib/gis/ls.c

@@ -1,6 +1,6 @@
 
 /**
-   \file ls.c
+   \file lib/gis/ls.c
 
    \brief Functions to list the files in a directory.
 

+ 1 - 1
lib/gis/ls_filter.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/ls_filter.c
+ * \file lib/gis/ls_filter.c
  *
  * \brief GIS Library - Filename filter functions
  *

+ 2 - 2
lib/gis/mapset_msc.c

@@ -1,9 +1,9 @@
 /*!
-   \file mapset_msc.c
+   \file lib/gis/mapset_msc.c
 
    \brief GIS library - Mapset user permission routines.
 
-   (C) 1999-2008 The GRASS development team
+   (C) 1999-2014 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.

+ 1 - 1
lib/gis/myname.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/myname.c
+ * \file lib/gis/myname.c
  *
  * \brief GIS Library - Database name functions.
  *

+ 1 - 1
lib/gis/open.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/open.c
+ * \file lib/gis/open.c
  * 
  * \brief GIS Library - Open file functions
  *

+ 1 - 1
lib/gis/parser_interface.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/parser_interface.c
+ * \file lib/gis/parser_interface.c
  *
  * \brief GIS Library - Argument parsing functions (interface)
  *

+ 1 - 1
lib/gis/pole_in_poly.c

@@ -1,5 +1,5 @@
 /*!
-  \file gis/pole_in_poly.c
+  \file lib/gis/pole_in_poly.c
 
   \brief GIS Library - Pole in polygon
   

+ 1 - 1
lib/gis/put_window.c

@@ -1,5 +1,5 @@
 /*!
-  \file gis/put_window.c
+  \file lib/gis/put_window.c
 
   \brief GIS Library - Modify window (i.e. GRASS region)
 

+ 1 - 1
lib/gis/radii.c

@@ -1,5 +1,5 @@
 /*!
-  \file gis/radii.c
+  \file lib/gis/radii.c
 
   \brief GIS Library - Calculating the Meridional Radius of Curvature
   

+ 1 - 1
lib/gis/remove.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/remove.c
+ * \file lib/gis/remove.c
  *
  * \brief GIS Library - File remove functions.
  *

+ 1 - 1
lib/gis/rename.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/rename.c
+ * \file lib/gis/rename.c
  *
  * \brief GIS Library - Rename file functions.
  *

+ 4 - 4
lib/gis/rhumbline.c

@@ -1,6 +1,6 @@
 
-/**
- * \file rhumbline.c
+/*!
+ * \file lib/gis/rhumbline.c
  *
  * \brief GIS Library - Rhumbline calculation routines.
  *
@@ -17,14 +17,14 @@
  * <br>
  * <b>WARNING:</b> This code is preliminary. It may not even be correct.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <math.h>

+ 2 - 2
lib/gis/rotate.c

@@ -1,9 +1,9 @@
 /*!
- * \file rotate.c
+ * \file lib/gis/rotate.c
  *
  * \brief GIS Library - rotate
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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

+ 1 - 1
lib/gis/short_way.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/short_way.c
+ * \file lib/gis/short_way.c
  *
  * \brief GIS Library - Shortest path functions.
  *

+ 3 - 3
lib/gis/snprintf.c

@@ -1,6 +1,6 @@
 
-/**
- * \file snprintf.c
+/*!
+ * \file lib/gis/snprintf.c
  *
  * \brief GIS Library - snprintf() clone functions.
  *
@@ -10,7 +10,7 @@
  *   - http://www.ijs.si/software/snprintf/
  *   - openssh's snprintf() implementation: bsd-snprintf.c
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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.

+ 3 - 3
lib/gis/spawn.c

@@ -1,10 +1,10 @@
 
-/**
- * \file spawn.c
+/*!
+ * \file lib/gis/spawn.c
  *
  * \brief GIS Library -  Handles process spawning.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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.

+ 1 - 1
lib/gis/timestamp.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/timestamp.c
+ * \file lib/gis/timestamp.c
  *
  * \brief GIS Library - Timestamp management
  *

+ 1 - 1
lib/gis/trim_dec.c

@@ -1,5 +1,5 @@
 /*!
- * \file trim_dec.c
+ * \file lib/gis/trim_dec.c
  *
  * \brief GIS Library - Trim string decimal functions.
  *

+ 1 - 1
lib/gis/units.c

@@ -1,5 +1,5 @@
 /*!
-  \file gis/units.c
+  \file lib/gis/units.c
 
   \brief GIS Library - Units management and conversion
   

+ 3 - 3
lib/gis/user_config.c

@@ -1,6 +1,6 @@
 
-/**
- * \file user_config.c
+/*!
+ * \file lib/gis/user_config.c
  *
  * \brief GIS Library - Routines related to user's GRASS configuration, tmp, and 
  * miscellaneous files.
@@ -15,7 +15,7 @@
  * subdirectories. There may be more functionality desired (such as 
  * deletion routines, directory globs).<br>
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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.

+ 3 - 3
lib/gis/view.c

@@ -1,10 +1,10 @@
 
-/**
- * \file view.c
+/*!
+ * \file lib/gis/view.c
  *
  * \brief GIS Library - 3D View functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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.

+ 1 - 1
lib/gis/whoami.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/whoami.c
+ * \file lib/gis/whoami.c
  *
  * \brief GIS Library - Login name functions.
  *

+ 4 - 4
lib/gis/wind_2_box.c

@@ -1,17 +1,17 @@
 
-/**
- * \file wind_2_box.c
+/*!
+ * \file lib/gis/wind_2_box.c
  *
  * \brief GIS Library - Window box functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <grass/gis.h>

+ 1 - 1
lib/gis/wind_format.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/wind_format.c
+ * \file lib/gis/wind_format.c
  *
  * \brief GIS Library - Window formatting functions.
  *

+ 2 - 2
lib/gis/wind_in.c

@@ -1,6 +1,6 @@
 
-/**
- * \file wind_in.c
+/*!
+ * \file lib/gis/wind_in.c
  *
  * \brief Point in region functions.
  *

+ 4 - 4
lib/gis/wind_limits.c

@@ -1,17 +1,17 @@
 
-/**
- * \file wind_limits.c
+/*!
+ * \file lib/gis/wind_limits.c
  *
  * \brief GIS Library - Projection limit functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <grass/gis.h>

+ 4 - 4
lib/gis/wind_overlap.c

@@ -1,17 +1,17 @@
 
-/**
- * \file wind_overlap.c
+/*!
+ * \file lib/gis/wind_overlap.c
  *
  * \brief GIS Library - Window overlap functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <grass/gis.h>

+ 12 - 0
lib/gis/worker.c

@@ -1,3 +1,15 @@
+/*!
+ * \file lib/gis/worker.c
+ *
+ * \brief GIS Library - Worker functions.
+ *
+ * (C) 2008-2014 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 Glynn Clements
+ */
 
 #include <stdio.h>
 #include <stdlib.h>

+ 4 - 4
lib/gis/wr_cellhd.c

@@ -1,17 +1,17 @@
 
-/**
- * \file wr_cellhd.c
+/*!
+ * \file lib/gis/wr_cellhd.c
  *
  * \brief GIS Library - Write Cell Header functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <stdio.h>

+ 4 - 4
lib/gis/writ_zeros.c

@@ -1,17 +1,17 @@
 
-/**
- * \file writ_zeros.c
+/*!
+ * \file lib/gis/writ_zeros.c
  *
  * \brief GIS Library - Write zero functions.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 1999-2008
+ * \date 1999-2014
  */
 
 #include <unistd.h>

+ 12 - 0
lib/gis/xdr.c

@@ -1,3 +1,15 @@
+/*!
+ * \file lib/gis/xdr.c
+ *
+ * \brief GIS Library - XDR related functions.
+ *
+ * (C) 2012-2014 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 Glynn Clements
+ */
 
 #include <stdlib.h>
 #include <string.h>

+ 1 - 1
lib/gis/zero.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/zero.c
+ * \file lib/gis/zero.c
  *
  * \brief GIS Library - Zeroing functions.
  *

+ 1 - 1
lib/gis/zone.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/zone.c
+ * \file lib/gis/zone.c
  *
  * \brief GIS Library - Cartographic zone functions.
  *