[GRASS-SVN] r32418 - grass/trunk/lib/gis
svn_grass at osgeo.org
svn_grass at osgeo.org
Thu Jul 31 15:21:30 EDT 2008
Author: martinl
Date: 2008-07-31 15:21:30 -0400 (Thu, 31 Jul 2008)
New Revision: 32418
Modified:
grass/trunk/lib/gis/adj_cellhd.c
grass/trunk/lib/gis/align_window.c
grass/trunk/lib/gis/alloc.c
grass/trunk/lib/gis/alloc_cell.c
grass/trunk/lib/gis/area.c
grass/trunk/lib/gis/area_ellipse.c
grass/trunk/lib/gis/area_poly1.c
grass/trunk/lib/gis/area_poly2.c
grass/trunk/lib/gis/area_sphere.c
grass/trunk/lib/gis/ascii_chk.c
grass/trunk/lib/gis/asprintf.c
grass/trunk/lib/gis/auto_mask.c
grass/trunk/lib/gis/basename.c
grass/trunk/lib/gis/bres_line.c
grass/trunk/lib/gis/color_get.c
grass/trunk/lib/gis/color_rule.c
grass/trunk/lib/gis/color_rule_get.c
grass/trunk/lib/gis/commas.c
grass/trunk/lib/gis/copy.c
grass/trunk/lib/gis/date.c
grass/trunk/lib/gis/debug.c
grass/trunk/lib/gis/distance.c
grass/trunk/lib/gis/done_msg.c
grass/trunk/lib/gis/endian.c
grass/trunk/lib/gis/geodist.c
grass/trunk/lib/gis/get_projinfo.c
grass/trunk/lib/gis/gisinit.c
grass/trunk/lib/gis/icon.c
grass/trunk/lib/gis/is.c
grass/trunk/lib/gis/legal_name.c
grass/trunk/lib/gis/locale.c
grass/trunk/lib/gis/maskfd.c
grass/trunk/lib/gis/myname.c
grass/trunk/lib/gis/overwrite.c
grass/trunk/lib/gis/parser.c
grass/trunk/lib/gis/percent.c
grass/trunk/lib/gis/remove.c
grass/trunk/lib/gis/rename.c
grass/trunk/lib/gis/rhumbline.c
grass/trunk/lib/gis/rotate.c
grass/trunk/lib/gis/set_window.c
grass/trunk/lib/gis/short_way.c
grass/trunk/lib/gis/snprintf.c
grass/trunk/lib/gis/spawn.c
grass/trunk/lib/gis/squeeze.c
grass/trunk/lib/gis/store.c
grass/trunk/lib/gis/strings.c
grass/trunk/lib/gis/system.c
grass/trunk/lib/gis/tempfile.c
grass/trunk/lib/gis/token.c
grass/trunk/lib/gis/trim_dec.c
grass/trunk/lib/gis/unctrl.c
grass/trunk/lib/gis/unix_socks.c
grass/trunk/lib/gis/user_config.c
grass/trunk/lib/gis/verbose.c
grass/trunk/lib/gis/view.c
grass/trunk/lib/gis/whoami.c
grass/trunk/lib/gis/wind_2_box.c
grass/trunk/lib/gis/wind_format.c
grass/trunk/lib/gis/wind_limits.c
grass/trunk/lib/gis/wind_overlap.c
grass/trunk/lib/gis/wind_scan.c
grass/trunk/lib/gis/window_map.c
grass/trunk/lib/gis/wr_cellhd.c
grass/trunk/lib/gis/writ_zeros.c
grass/trunk/lib/gis/yes.c
grass/trunk/lib/gis/zero.c
grass/trunk/lib/gis/zero_cell.c
Log:
gislib: doxygen cleaning, remove 'fn' statements
Modified: grass/trunk/lib/gis/adj_cellhd.c
===================================================================
--- grass/trunk/lib/gis/adj_cellhd.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/adj_cellhd.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file adj_cellhd.c
*
- * \brief CELL header adjustment.
+ * \brief GIS Library - CELL header adjustment.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
@@ -16,8 +18,6 @@
/**
- * \fn char *G_adjust_Cell_head (struct Cell_head *cellhd, int row_flag, int col_flag)
- *
* \brief Adjust cell header.
*
* This function fills in missing parts of the input
@@ -160,8 +160,6 @@
/**
- * \fn char *G_adjust_Cell_head3 (struct Cell_head *cellhd, int row_flag, int col_flag, int depth_flag)
- *
* \brief Adjust cell header for 3D values.
*
* This function fills in missing parts of the input
Modified: grass/trunk/lib/gis/align_window.c
===================================================================
--- grass/trunk/lib/gis/align_window.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/align_window.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file align_window.c
*
- * \brief Window alignment functions.
+ * \brief GIS Library - Window alignment functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdio.h>
@@ -17,8 +19,6 @@
/**
- * \fn char *G_align_window (struct Cell_head *window, const struct Cell_head *ref)
- *
* \brief Align two regions.
*
* Modifies the input <b>window</b> to align to
Modified: grass/trunk/lib/gis/alloc.c
===================================================================
--- grass/trunk/lib/gis/alloc.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/alloc.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file alloc.c
*
- * \brief Memory allocation routines.
+ * \brief GIS Library - Memory allocation routines.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdlib.h>
@@ -17,8 +19,6 @@
/**
- * \fn void *G_malloc (size_t n)
- *
* \brief Memory allocation.
*
* Allocates a block of
@@ -45,8 +45,6 @@
/**
- * \fn void *G_calloc (size_t m, size_t n)
- *
* \brief Memory allocation.
*
* Allocates a
@@ -78,8 +76,6 @@
/**
- * \fn void *G_realloc (void *buf, size_t n)
- *
* \brief Memory reallocation.
*
* Changes the
@@ -114,8 +110,6 @@
/**
- * \fn void G_free(void *buf)
- *
* \brief Free allocated memory.
*
* \param[in,out] buf buffer holding original data
Modified: grass/trunk/lib/gis/alloc_cell.c
===================================================================
--- grass/trunk/lib/gis/alloc_cell.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/alloc_cell.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file alloc_cell.c
*
- * \brief Raster allocation routines.
+ * \brief GIS Library - Raster allocation routines.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <math.h>
@@ -22,8 +24,6 @@
/**
- * \fn size_t G_raster_size (RASTER_MAP_TYPE data_type)
- *
* \brief Returns size of a raster CELL in bytes.
*
* If <b>data_type</b> is CELL_TYPE, returns sizeof(CELL)
@@ -42,8 +42,6 @@
/**
- * \fn CELL *G_allocate_cell_buf (void)
- *
* \brief Allocate memory for a CELL type raster map.
*
* This routine allocates a buffer of type CELL just large enough to
@@ -71,8 +69,6 @@
/**
- * \fn void *G_allocate_raster_buf (RASTER_MAP_TYPE data_type)
- *
* \brief Allocate memory for a raster map of type <b>data_type</b>.
*
* Allocate an array of CELL, FCELL, or DCELL (depending on
@@ -92,8 +88,6 @@
/**
- * \fn CELL *G_allocate_c_raster_buf (void)
- *
* \brief Allocates memory for a raster map of type CELL.
*
* Allocate an array of CELL based on the number of columns in the
@@ -110,8 +104,6 @@
/**
- * \fn FCELL *G_allocate_f_raster_buf (void)
- *
* \brief Allocates memory for a raster map of type FCELL.
*
* Allocate an array of FCELL based on the number of columns in the
@@ -128,8 +120,6 @@
/**
- * \fn DCELL *G_allocate_d_raster_buf (void)
- *
* \brief Allocates memory for a raster map of type DCELL.
*
* Allocate an array of DCELL based on the number of columns in the
@@ -146,8 +136,6 @@
/**
- * \fn char *G_allocate_null_buf (void)
- *
* \brief Allocates memory for a null buffer.
*
* Allocate an array of char based on the number of columns in the
@@ -164,8 +152,6 @@
/**
- * \fn unsigned char *G__allocate_null_bits (int cols)
- *
* \brief Allocates memory for null bits.
*
* Allocates an array of unsigned char based on <b>cols</b>.
@@ -183,8 +169,6 @@
/**
- * \fn int G__null_bitstream_size (int cols)
- *
* \brief Determines null bitstream size.
*
* \param[in] cols number of columns
Modified: grass/trunk/lib/gis/area.c
===================================================================
--- grass/trunk/lib/gis/area.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/area.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file area.c
*
- * \brief Area calculation functions.
+ * \brief GIS Library - Area calculation functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
@@ -28,8 +30,6 @@
/**
- * \fn int G_begin_cell_area_calculations (void)
- *
* \brief Begin cell area calculations.
*
* This routine must be called once before any call to
@@ -80,8 +80,6 @@
/**
- * \fn double G_area_of_cell_at_row (int row)
- *
* \brief Cell area in specified <b>row</b>.
*
* This routine returns the area in square meters of a cell in the
@@ -115,8 +113,6 @@
/**
- * \fn int G_begin_polygon_area_calculations (void)
- *
* \brief Begin polygon area calculations.
*
* This initializes the polygon area calculation routines. It is used
@@ -150,8 +146,6 @@
/**
- * \fn double G_area_of_polygon (const double *x, const double *y, int n)
- *
* \brief Area in square meters of polygon.
*
* Returns the area in square meters of the polygon described by the
Modified: grass/trunk/lib/gis/area_ellipse.c
===================================================================
--- grass/trunk/lib/gis/area_ellipse.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/area_ellipse.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file area_ellipse.c
*
- * \brief Ellipse area routines.
+ * \brief GIS Library - Ellipse area routines.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <math.h>
@@ -26,8 +28,6 @@
*/
/**
- * \fn int G_begin_zone_area_on_ellipsoid (double a, double e2, double s)
- *
* \brief Begin area calculations for ellipsoid.
*
* Initializes raster area calculations for an ellipsoid, where <b>a</b>
@@ -56,8 +56,6 @@
/**
- * \fn double G_darea0_on_ellipsoid (double lat)
- *
* \brief Calculate integral for area between two latitudes.
*
* This routine is part of the integral for the area between two
@@ -79,8 +77,6 @@
/**
- * \fn double G_area_for_zone_on_ellipsoid (double north, double south)
- *
* \brief Calculates area between latitudes.
*
* This routine shows how to calculate area between two lats, but
Modified: grass/trunk/lib/gis/area_poly1.c
===================================================================
--- grass/trunk/lib/gis/area_poly1.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/area_poly1.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file area_poly1.c
*
- * \brief Polygon area calculation routines.
+ * \brief GIS Library - Polygon area calculation routines.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <math.h>
@@ -47,8 +49,6 @@
/**
- * \fn int G_begin_ellipsoid_polygon_area (double a, double e2)
- *
* \brief Begin area calculations.
*
* This initializes the polygon area calculations for the
@@ -87,8 +87,6 @@
/**
- * \fn double G_ellipsoid_polygon_area (const double *lon, const double *lat, int n)
- *
* \brief Area of lat-long polygon.
*
* Returns the area in square meters of the polygon described by the
Modified: grass/trunk/lib/gis/area_poly2.c
===================================================================
--- grass/trunk/lib/gis/area_poly2.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/area_poly2.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file area_poly2.c
*
- * \brief Planimetric polygon area calculation routines.
+ * \brief GIS Library - Planimetric polygon area calculation routines.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn double G_planimetric_polygon_area (const double *x, const double *y, int n)
- *
* \brief Calculates planimetric polygon area.
*
* \param[in] x array of x values
Modified: grass/trunk/lib/gis/area_sphere.c
===================================================================
--- grass/trunk/lib/gis/area_sphere.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/area_sphere.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file area_sphere.c
*
- * \brief Sphereical area calculation routines.
+ * \brief GIS Library - Sphereical area calculation routines.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <math.h>
@@ -24,8 +26,6 @@
*/
/**
- * \fn int G_begin_zone_area_on_sphere (double r, double s)
- *
* \brief Initialize calculations for sphere.
*
* Initializes raster area calculations for a sphere.
@@ -45,8 +45,6 @@
/**
- * \fn double G_darea0_on_sphere (double lat)
- *
* \brief Calculates integral for area between two latitudes.
*
* \param[in] lat latitude
@@ -60,8 +58,6 @@
/**
- * \fn double G_area_for_zone_on_sphere (double north, double south)
- *
* \brief Calculates area between latitudes.
*
* This routine shows how to calculate area between two lats, but
Modified: grass/trunk/lib/gis/ascii_chk.c
===================================================================
--- grass/trunk/lib/gis/ascii_chk.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/ascii_chk.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file ascii_chk.c
*
- * \brief
+ * \brief GIS Library - Remove non-ascii characters
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
@@ -19,8 +21,6 @@
/**
- * \fn int G_ascii_check (char *string)
- *
* \brief Removes non-ascii characters from buffer.
*
* Updates <b>string</b> with non_ascii characters removed, except for
Modified: grass/trunk/lib/gis/asprintf.c
===================================================================
--- grass/trunk/lib/gis/asprintf.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/asprintf.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,7 +1,7 @@
/**
* \file asprintf.c
*
- * \brief GRASS implementation of asprintf().
+ * \brief GIS Library - GRASS implementation of asprintf().
*
* Eric G. Miller - Thu, 2 May 2002 17:51:54 -0700
*
@@ -14,12 +14,14 @@
* <b>WARNING:</b> Temporarily, the G_asprintf macro cannot be used. See
* explanation in gisdefs.h.
*
+ * (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 Eric Miller - egm2 at jps net
*
- * \date 2002-2006
+ * \date 2002-2008
*/
#define _GNU_SOURCE /* enable asprintf */
@@ -39,8 +41,6 @@
#ifndef G_asprintf
/**
- * \fn int G_asprintf (char **out, const char *fmt, ...)
- *
* \brief Safe replacement for <i>asprintf()</i>.
*
* Allocate a string large enough to hold the new output, including the
Modified: grass/trunk/lib/gis/auto_mask.c
===================================================================
--- grass/trunk/lib/gis/auto_mask.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/auto_mask.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file auto_mask.c
*
- * \brief Auto masking routines.
+ * \brief GIS Library - Auto masking routines.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdlib.h>
@@ -18,8 +20,6 @@
/**
- * \fn int G__check_for_auto_masking ()
- *
* \brief Checks for auto masking.
*
* On first call, opens the mask file if declared and available and
@@ -76,8 +76,6 @@
/**
- * \fn int G_suppress_masking ()
- *
* \brief Suppresses masking.
*
* \return always returns 0
@@ -98,8 +96,6 @@
/**
- * \fn int G_unsuppress_masking ()
- *
* \brief Unsuppresses masking.
*
* \return always returns 0
Modified: grass/trunk/lib/gis/basename.c
===================================================================
--- grass/trunk/lib/gis/basename.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/basename.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,8 +1,10 @@
/**
* \file basename.c
*
- * \brief Program basename routines.
+ * \brief GIS Library - Program basename routines.
*
+ * (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.
*
@@ -18,8 +20,6 @@
/**
- * \fn char * G_basename (char *filename, const char *desired_ext)
- *
* \brief Truncates filename to the base part (before the last '.')
* if it matches the extension, otherwise leaves it unchanged.
*
Modified: grass/trunk/lib/gis/bres_line.c
===================================================================
--- grass/trunk/lib/gis/bres_line.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/bres_line.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/*
* \file bres_line.c
*
- * \brief Bresenham line routines.
+ * \brief GIS Library - Bresenham line routines.
*
+ * (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 1999-2007
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_bresenham_line (int x0, int y0, int x1, int y1, int (*point)())
- *
* \brief Bresenham line algorithm.
*
* Draws a line from <b>x1,y1</b> to <b>x2,y2</b> using Bresenham's
Modified: grass/trunk/lib/gis/color_get.c
===================================================================
--- grass/trunk/lib/gis/color_get.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/color_get.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file color_get.c
*
- * \brief Functions to get colors from a raster map.
+ * \brief GIS Library - Functions to get colors from a raster map.
*
- * This program is free software under the GNU General Public License
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_get_color (CELL n, int *red, int *grn, int *blu, struct Colors *colors)
- *
* \brief Get a category color.
*
* The <b>red, green</b>, and
@@ -49,8 +49,6 @@
/**
- * \fn int G_get_raster_color (void *rast, int *red, int *grn, int *blu, struct Colors *colors, RASTER_MAP_TYPE map_type)
- *
* \brief Gets color from raster.
*
* Looks up the rgb colors for
@@ -82,8 +80,6 @@
/**
- * \fn int G_get_c_raster_color (CELL *rast, int *red, int *grn, int *blu, struct Colors *colors)
- *
* \brief Gets color for a CELL raster.
*
* Looks up the rgb colors for CELL
@@ -106,8 +102,6 @@
/**
- * \fn int G_get_f_raster_color (FCELL *rast, int *red, int *grn, int *blu, struct Colors *colors)
- *
* \brief Gets color for a FCELL raster.
*
* Looks up the rgb colors for FCELL <em>rast</em> in the color table
@@ -130,8 +124,6 @@
/**
- * \fn int G_get_d_raster_color (DCELL *rast, int *red, int *grn, int *blu, struct Colors *colors)
- *
* \brief Gets color for a DCELL raster.
*
* Looks up the rgb colors for DCELL <em>rast</em> in the color table
@@ -154,8 +146,6 @@
/**
- * \fn int G_get_null_value_color (int *red, int *grn, int *blu, const struct Colors *colors)
- *
* \brief Gets color for null value.
*
* Puts the red, green, and blue components of <b>colors</b> for the
@@ -191,8 +181,6 @@
/**
- * \fn int G_get_default_color (int *red, int *grn, int *blu, const struct Colors *colors)
- *
* \brief Gets default color.
*
* Puts the red, green, and blue components of the
Modified: grass/trunk/lib/gis/color_rule.c
===================================================================
--- grass/trunk/lib/gis/color_rule.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/color_rule.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,3 +1,18 @@
+/**
+ * \file color_rule.c
+ *
+ * \brief GIS Library - Color rules.
+ *
+ * (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 1999-2008
+ */
+
#include <grass/gis.h>
#define LIMIT(x) if (x < 0) x = 0; else if (x > 255) x = 255;
@@ -9,24 +24,16 @@
/*!
- * \brief
+ * \brief Adds the floating-point rule (DCELL version)
*
- * Adds the floating-point rule that the range [<em>v1,v2</em>] gets a
- * linear ramp of colors from [<em>r1,g1,b1</em>] to
- * [<em>r2,g2,b2</em>].
- * If either <em>v1</em> or <em>v2</em> is the NULL-value, this call is converted into
- * <tt>G_set_null_value_color (r1, g1, b1, colors)</tt>
+ * See G_add_raster_color_rule() for details.
*
- * \param v1
- * \param r1
- * \param g1
- * \param b1
- * \param v2
- * \param r2
- * \param g2
- * \param b2
- * \param colors
- * \return int
+ * \param v1 cell value
+ * \param r1,g1,b1 color value
+ * \param v2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ * \return 1
*/
int
@@ -39,24 +46,16 @@
/*!
- * \brief
+ * \brief Adds the floating-point rule (FCELL version)
*
- * Adds the floating-point rule that the range [<em>v1,v2</em>] gets a
- * linear ramp of colors from [<em>r1,g1,b1</em>] to
- * [<em>r2,g2,b2</em>].
- * If either <em>v1</em> or <em>v2</em> is the NULL-value, this call is converted into
- * <tt>G_set_null_value_color (r1, g1, b1, colors)</tt>
+ * See G_add_raster_color_rule() for details.
*
- * \param v1
- * \param r1
- * \param g1
- * \param b1
- * \param v2
- * \param r2
- * \param g2
- * \param b2
- * \param colors
- * \return int
+ * \param v1 cell value
+ * \param r1,g1,b1 color value
+ * \param v2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ * \return 1
*/
int
@@ -69,20 +68,16 @@
/*!
- * \brief
+ * \brief Adds the floating-point rule (CCELL version)
*
- * Calls G_add_color_rule(*v1, r1, g1, b1, *v2, r2, g2, b2, colors).
+ * See G_add_raster_color_rule() for details.
*
- * \param v1
- * \param r1
- * \param g1
- * \param b1
- * \param v2
- * \param r2
- * \param g2
- * \param b2
- * \param colors
- * \return int
+ * \param v1 cell value
+ * \param r1,g1,b1 color value
+ * \param v2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ * \return 1
*/
int
@@ -95,26 +90,25 @@
/*!
- * \brief
+ * \brief Adds the floating-point rule
*
- * If <em>map_type</em> is CELL_TYPE, calls G_add_c_raster_color_rule ((CELL
- * *) v1, r1, g1, b1, (CELL *) v2, r2, g2, b2, colors);
- * If <em>map_type</em> is FCELL_TYPE, calls G_add_f_raster_color_rule
- * ((FCELL *) v1, r1, g1, b1, (FCELL *) v2, r2, g2, b2, colors);
- * If <em>map_type</em> is DCELL_TYPE, calls G_add_d_raster_color_rule
- * ((DCELL *) v1, r1, g1, b1, (DCELL *) v2, r2, g2, b2, colors);
+ * Adds the floating-point rule that the range [<em>v1,v2</em>] gets a
+ * linear ramp of colors from [<em>r1,g1,b1</em>] to
+ * [<em>r2,g2,b2</em>].
+ * If either <em>v1</em> or <em>v2</em> is the NULL-value, this call is converted into
+ * <tt>G_set_null_value_color (r1, g1, b1, colors)</tt>
*
- * \param v1
- * \param r1
- * \param g1
- * \param b1
- * \param v2
- * \param r2
- * \param g2
- * \param b2
- * \param colors
- * \param map_type
- * \return int
+ * - If <em>map_type</em> is CELL_TYPE, calls G_add_c_raster_color_rule()
+ * - If <em>map_type</em> is FCELL_TYPE, calls G_add_f_raster_color_rule()
+ * - If <em>map_type</em> is DCELL_TYPE, calls G_add_d_raster_color_rule()
+ *
+ * \param v1 cell value
+ * \param r1,g1,b1 color value
+ * \param v2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ * \param data_type raster data type (CELL, FCELL, DCELL)
+ * \return 1
*/
int
@@ -127,7 +121,7 @@
/*!
- * \brief set colors
+ * \brief Set colors rules
*
* This is the heart
* and soul of the new color logic. It adds a color rule to the <b>colors</b>
@@ -150,16 +144,12 @@
* <i>G_init_colors.</i> See Predefined_Color_Tables for routines to
* build some predefined color tables.
*
- * \param cat1
- * \param r1
- * \param g1
- * \param b1
- * \param cat2
- * \param r2
- * \param g2
- * \param b2
- * \param colors
- * \return int
+ * \param cat1 cell value
+ * \param r1,g1,b1 color value
+ * \param cat2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ * \return 1
*/
int
@@ -170,12 +160,24 @@
return 1;
}
+/**
+ * \brief Add modular color rule (DCELL version)
+ *
+ * \param val1 cell value
+ * \param r1,g1,b1 color value
+ * \param val2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ *
+ * \return -1 on failure
+ * \return 1 on success
+ */
int
G_add_modular_d_raster_color_rule (const DCELL *val1, int r1, int g1, int b1, const DCELL *val2, int r2, int g2, int b2, struct Colors *colors)
{
DCELL min, max;
if (colors->version < 0)
- return -1; /* can;t use this on 3.0 colors */
+ return -1; /* can't use this on 3.0 colors */
min = colors->cmin;
max = colors->cmax;
add_color_rule (val1, r1,g1,b1, val2, r2,g2,b2, &colors->modular, 0,
@@ -186,6 +188,18 @@
return 1;
}
+/**
+ * \brief Add modular color rule (FCELL version)
+ *
+ * \param val1 cell value
+ * \param r1,g1,b1 color value
+ * \param val2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ *
+ * \return -1 on failure
+ * \return 1 on success
+ */
int
G_add_modular_f_raster_color_rule (const FCELL *val1, int r1, int g1, int b1, const FCELL *val2, int r2, int g2, int b2, struct Colors *colors)
{
@@ -202,12 +216,40 @@
return 1;
}
+/**
+ * \brief Add modular color rule (CCELL version)
+ *
+ * \param val1 cell value
+ * \param r1,g1,b1 color value
+ * \param val2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ *
+ * \return -1 on failure
+ * \return 1 on success
+ */
int
G_add_modular_c_raster_color_rule (const CELL *val1, int r1, int g1, int b1, const CELL *val2, int r2, int g2, int b2, struct Colors *colors)
{
return G_add_modular_color_rule (*val1, r1,g1,b1, *val2, r2,g2,b2, colors);
}
+/**
+ * \brief Add modular color rule
+ *
+ * Question: shouldn't this function call
+ * G_add_modular_<data_type>_raster_color_rule() instead???
+ *
+ * \param val1 cell value
+ * \param r1,g1,b1 color value
+ * \param val2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ * \param data_type raster data type
+ *
+ * \return -1 on failure
+ * \return 1 on success
+ */
int
G_add_modular_raster_color_rule (const void *val1, int r1, int g1, int b1, const void *val2, int r2, int g2, int b2, struct Colors *colors, RASTER_MAP_TYPE data_type)
{
@@ -224,6 +266,22 @@
return 1;
}
+/**
+ * \brief Add modular color rule
+ *
+ * This function seems to be same as
+ * G_add_modular_raster_color_rule(). Can be removed?
+ *
+ * \param val1 cell value
+ * \param r1,g1,b1 color value
+ * \param val2 cell value
+ * \param r2,g2,b2 color value
+ * \param[in,out] colors pointer to color table structure
+ * \param data_type raster data type
+ *
+ * \return -1 on failure
+ * \return 1 on success
+ */
int
G_add_modular_color_rule (CELL cat1, int r1, int g1, int b1, CELL cat2, int r2, int g2, int b2, struct Colors *colors)
{
Modified: grass/trunk/lib/gis/color_rule_get.c
===================================================================
--- grass/trunk/lib/gis/color_rule_get.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/color_rule_get.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,10 +1,26 @@
+/**
+ * \file color_rule_get.c
+ *
+ * \brief GIS Library - Get color rules.
+ *
+ * (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 1999-2008
+ */
+
#include <grass/gis.h>
/*!
- \fn G_colors_count ( struct Colors *colors )
- \brief get both modular and fixed rules count
- \return number of rules in color table
- \param colors pointer to color table structure
+ \brief Get both modular and fixed rules count
+
+ \param colors pointer to color table structure
+
+ \return number of rules in color table
*/
int G_colors_count ( const struct Colors *colors )
{
@@ -33,13 +49,19 @@
}
/*!
- \fn G_get_f_color_rule ( struct Colors *colors )
- \brief get color rule from both modular and fixed rules
- rules are returned in the order as stored in the table (i.e. unexpected, high values first)
- \return 0 success
- \return 1 index out of range
- \param colors pointer to color table structure
- \param rule rule index from 0 to G_color_count()-1
+ \brief Get color rule from both modular and fixed rules
+
+ Rules are returned in the order as stored in the table (i.e. unexpected, high values first)
+
+ \param val1 color value
+ \param[out] r1,g1,b1 color value
+ \param val2 color value
+ \param[out] r2,g2,b2 color value
+ \param colors pointer to color table structure
+ \param rule rule index from 0 to G_color_count()-1
+
+ \return 0 success
+ \return 1 index out of range
*/
int G_get_f_color_rule ( DCELL *val1, unsigned char *r1, unsigned char *g1, unsigned char *b1,
DCELL *val2, unsigned char *r2, unsigned char *g2, unsigned char *b2,
@@ -92,4 +114,3 @@
return 0;
}
-
Modified: grass/trunk/lib/gis/commas.c
===================================================================
--- grass/trunk/lib/gis/commas.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/commas.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file commas.c
*
- * \brief Comma string functions.
+ * \brief GIS Library - Comma string functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <string.h>
@@ -16,19 +18,18 @@
/**
- * \fn int G_insert_commas (char *buf)
- *
* \brief Inserts commas into a number string.
*
- * Examples:<br>
- * 1234567 becomes 1,234,567<br>
- * 1234567.89 becomes 1,234,567.89<br>
- * 12345 becomes 12,345<br>
- * 1234 stays 1234<br>
+ * Examples:
*
+ * - 1234567 becomes 1,234,567
+ * - 1234567.89 becomes 1,234,567.89
+ * - 12345 becomes 12,345
+ * - 1234 stays 1234
+ *
* <b>Note:</b> Does not work with negative numbers.
*
- * \param[in,out] buf
+ * \param[in,out] buf string
* \return 1 if no commas inserted
* \return 0 if commas inserted
*/
@@ -72,17 +73,15 @@
/**
- * \fn int G_remove_commas (char *buf)
- *
* \brief Removes commas from number string.
*
- * Examples:<br>
- * 1,234,567 becomes 1234567<br>
- * 1,234,567.89 becomes 1234567.89<br>
- * 12,345 becomes 12345<br>
- * 1234 stays 1234
+ * Examples:
+ * - 1,234,567 becomes 1234567<br>
+ * - 1,234,567.89 becomes 1234567.89<br>
+ * - 12,345 becomes 12345<br>
+ * - 1234 stays 1234
*
- * \param[in,out] buf
+ * \param[in,out] buf string
* \return always returns 0
*/
Modified: grass/trunk/lib/gis/copy.c
===================================================================
--- grass/trunk/lib/gis/copy.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/copy.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file copy.c
*
- * \brief Memory copy functions.
+ * \brief GIS Library - Memory copy functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
#include <string.h>
/**
- * \fn int G_copy (void *a, const void *b, int n)
- *
* \brief Copies <b>n</b> bytes starting at address <b>b</b> into
* address <b>a</b>.
*
Modified: grass/trunk/lib/gis/date.c
===================================================================
--- grass/trunk/lib/gis/date.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/date.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file date.c
*
- * \brief Date functions.
+ * \brief GIS Library - Date functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <time.h>
@@ -16,8 +18,6 @@
/**
- * \fn char *G_date (void)
- *
* \brief Current date and time.
*
* Returns a pointer to a string which is the current date and time. The
Modified: grass/trunk/lib/gis/debug.c
===================================================================
--- grass/trunk/lib/gis/debug.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/debug.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file debug.c
*
- * \brief Debug functions.
+ * \brief GIS Library - Debug functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdio.h>
@@ -24,20 +26,18 @@
/**
- * \fn int G_debug (int level, char *msg,...)
- *
* \brief Print debugging message.
*
* Print debugging message if environment variable GRASS_DEBUG_LEVEL
* is set to level equal or greater
*
* Levels: (recommended levels)<br>
- * 1 - message is printed once or few times per module<br>
- * 3 - each row (raster) or line (vector)<br>
- * 5 - each cell (raster) or point (vector)
+ * - 1 - message is printed once or few times per module<br>
+ * - 3 - each row (raster) or line (vector)<br>
+ * - 5 - each cell (raster) or point (vector)
*
- * \param[in] level
- * \param[in] msg
+ * \param[in] level level
+ * \param[in] msg message
* \return 0 on error
* \return 1 on success
*/
@@ -88,16 +88,13 @@
/**
- * \fn int G_dump (int fd)
- *
* \brief Dumps status of various GIS parameters.
*
* Dumps status of various GIS parameters of a particular
* file descriptor, <b>fd</b>.
*
- * \param[in] fd
+ * \param[in] fd file
* \return always returns 0
- *
*/
int G_dump(int fd)
Modified: grass/trunk/lib/gis/distance.c
===================================================================
--- grass/trunk/lib/gis/distance.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/distance.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,12 +1,14 @@
/**
* \file distance.c
*
- * \brief Distance calculation functions.
+ * \brief GIS Library - Distance calculation functions.
*
* WARNING: this code is preliminary and may be changed,
* including calling sequences to any of the functions
* defined here.
*
+ * (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.
*
@@ -17,8 +19,8 @@
#include <math.h>
#include <grass/gis.h>
+#include <grass/glocale.h>
-
static double min4(double, double, double, double);
static double min2(double, double);
@@ -28,8 +30,6 @@
/**
- * \fn int G_begin_distance_calculations (void)
- *
* \brief Begin distance calculations.
*
* Initializes the distance calculations. It is used both for the
@@ -64,8 +64,6 @@
/**
- * \fn double G_distance (double e1, double n1, double e2, double n2)
- *
* \brief Returns distance in meters.
*
* This routine computes the distance, in meters, from
@@ -73,11 +71,9 @@
* latitude-longitude, this distance is measured along the geodesic. Two
* routines perform geodesic distance calculations.
*
- * \param[in] x1
- * \param[in] y1
- * \param[in] x2
- * \param[in] y2
- * \return double
+ * \param[in] e1,n1 east-north coordinates of first point
+ * \param[in] e2,n2 east-north coordinates of second point
+ * \return distance
*/
double G_distance (double e1,double n1,double e2,double n2)
@@ -90,18 +86,10 @@
/**
- * \fn double G_distance_between_line_segments (double ax1, double ay1, double ax2, double ay2, double bx1, double by1, double bx2, double by2)
- *
* \brief Returns distance between two line segments in meters.
*
- * \param[in] ax1
- * \param[in] ay1
- * \param[in] ax2
- * \param[in] ay2
- * \param[in] bx1
- * \param[in] by2
- * \param[in] bx2
- * \param[in] by2
+ * \param[in] ax1,ay2,ax2,ay2 first segment
+ * \param[in] bx1,by2,bx2,by2 second segment
* \return double
*/
@@ -130,17 +118,12 @@
/**
- * \fn double G_distance_point_to_line_segment (double xp, double yp, double x1, double y1, double x2, double y2)
- *
* \brief Returns distance between a point and line segment in meters.
*
- * \param[in] xp
- * \param[in] yp
- * \param[in] x1
- * \param[in] y1
- * \param[in] x2
- * \param[in] y2
- * \return double
+ * \param[in] xp,yp point coordinates
+ * \param[in] x1,x1 segment point coordinates
+ * \param[in] x2,y2 segment point coordinates
+ * \return distance
*/
double
@@ -179,8 +162,9 @@
break;
default:
/* parallel/colinear cases shouldn't occur with perpendicular lines */
- fprintf (stderr,"G_distance_point_to_line_segment: shouldn't happen\n");
-fprintf(stderr," code=%d P=(%f,%f) S=(%f,%f)(%f,%f)\n",t,xp,yp,x1,y1,x2,y2);
+ G_warning (_("G_distance_point_to_line_segment: shouldn't happen: "
+ "code=%d P=(%f,%f) S=(%f,%f)(%f,%f)"),
+ t, xp, yp, x1, y1, x2, y2);
return -1.0;
}
Modified: grass/trunk/lib/gis/done_msg.c
===================================================================
--- grass/trunk/lib/gis/done_msg.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/done_msg.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,24 +1,24 @@
/**
* \file done_msg.c
*
- * \brief Done message functions.
+ * \brief GIS Library - Done message functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
+#include <stdarg.h>
+
#include <grass/gis.h>
#include <grass/glocale.h>
-#include <stdarg.h>
-
/**
- * \fn int G_done_msg (const char *msg, ...)
- *
* \brief Print a final message.
*
* \param[in] msg string. Cannot be NULL.
Modified: grass/trunk/lib/gis/endian.c
===================================================================
--- grass/trunk/lib/gis/endian.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/endian.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file endian.c
*
- * \brief Functions to determine architecture endian.
+ * \brief GIS Library - Functions to determine architecture endian.
*
* This endian test was taken from ./src.contrib/GMSL/NVIZ2.2/TOGL/apps/image.c.
*
+ * (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 Markus Neteler
*
- * \date 2001-2006
+ * \date 2001-2008
*/
/**
- * \fn int G_is_little_endian (void)
- *
* \brief Tests for little ENDIAN.
*
* Test if machine is little or big endian.
Modified: grass/trunk/lib/gis/geodist.c
===================================================================
--- grass/trunk/lib/gis/geodist.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/geodist.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,24 +1,25 @@
/**
* \file geodist.c
*
- * \brief Geodesic distance routines.
+ * \brief GIS Library - Geodesic distance routines.
*
- * Distance from point to point along a geodesic code from
- * Paul D. Thomas, 1970<br>
- * "Spheroidal Geodesics, Reference Systems, and Local Geometry"<br>
- * U.S. Naval Oceanographic Office, p. 162<br>
+ * Distance from point to point along a geodesic code from Paul
+ * D. Thomas, 1970<br> "Spheroidal Geodesics, Reference Systems, and
+ * Local Geometry"<br> U.S. Naval Oceanographic Office, p. 162<br>
* Engineering Library 526.3 T36s
* http://stinet.dtic.mil/oai/oai?&verb=getRecord&metadataPrefix=html&identifier=AD0703541
*
- * <b>WARNING:</b> this code is preliminary and may be changed,
+ * <b>WARNING:</b> this code is preliminary and may be changed,
* including calling sequences to any of the functions defined here.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <math.h>
@@ -34,8 +35,6 @@
/**
- * \fn int G_begin_geodesic_distance (double a, double e2)
- *
* \brief Begin geodesic distance.
*
* Initializes the distance calculations for the ellipsoid with
@@ -62,12 +61,10 @@
/**
- * \fn int G_set_geodesic_distance_lat1 (double lat1)
- *
* \brief Sets geodesic distance lat1.
*
* Set the first latitude.
- * <br>
+ *
* <b>Note:</b> Must be called first.
*
* \param[in] lat1 first latitude
@@ -83,12 +80,10 @@
/**
- * \fn int G_set_geodesic_distance_lat2 (double lat2)
- *
* \brief Sets geodesic distance lat2.
*
* Set the second latitude.
- * <br>
+ *
* <b>Note:</b> Must be called second.
*
* \param[in] lat2 second latitidue
@@ -124,8 +119,6 @@
/**
- * \fn double G_geodesic_distance_lon_to_lon (double lon1, double lon2)
- *
* \brief Calculates geodesic distance.
*
* Calculates the geodesic distance from <b>lon1,lat1</b> to
@@ -206,8 +199,6 @@
/**
- * \fn double G_geodesic_distance (double lon1, double lat1, double lon2, double lat2)
- *
* \brief Calculates geodesic distance.
*
* Calculates the geodesic distance from <b>lon1,lat1</b> to
@@ -215,11 +206,9 @@
* <br>
* <b>Note:</b> The calculation of the geodesic distance is fairly costly.
*
- * \param[in] lon1 first longitude
- * \param[in] lat1 first latitude
- * \param[in] lon2 second longitude
- * \param[in] lat2 second latitude
- * \return double distance in meters
+ * \param[in] lon1,lat1 longitude,latitude of first point
+ * \param[in] lon2,lat2 longitude,latitude of second point
+ * \return distance in meters
*/
double G_geodesic_distance (double lon1,double lat1,double lon2,double lat2)
Modified: grass/trunk/lib/gis/get_projinfo.c
===================================================================
--- grass/trunk/lib/gis/get_projinfo.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/get_projinfo.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,9 +1,9 @@
/*!
* \file get_projinfo.c
*
- * \brief GRASS GIS Library
+ * \brief GIS Library - Get projection info
*
- * (C) 1999-2007 by the GRASS Development Team
+ * (C) 1999-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
@@ -18,8 +18,6 @@
#define PERMANENT "PERMANENT"
/*!
- * \fn struct Key_Value* G_get_projunits(void)
- *
* \brief Gets unit information for location
*
* \return pointer to Key_Value structure with key/value pairs
@@ -49,8 +47,6 @@
}
/*!
- * \fn struct Key_Value* G_get_projinfo(void)
- *
* \brief Gets projection information for location
*
* \return pointer to Key_Value structure with key/value pairs
Modified: grass/trunk/lib/gis/gisinit.c
===================================================================
--- grass/trunk/lib/gis/gisinit.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/gisinit.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file gisinit.c
*
- * \brief Handles program initialization.
+ * \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-2006
+ * \date 2000-2008
*/
#include <stdio.h>
@@ -28,8 +30,6 @@
/**
- * \fn int G_gisinit (const char *pgm)
- *
* \brief Initialize GRASS GIS engine.
*
* Initializes GIS engine and ensures a valid mapset is available.
@@ -72,8 +72,6 @@
/**
- * \fn int G_no_gisinit (void)
- *
* \brief Initialize GRASS GIS engine.
*
* Initializes GIS engine, but does not check for a valid mapset.
@@ -96,8 +94,6 @@
/**
- * \fn int G__check_gisinit (void)
- *
* \brief Checks to see if GIS engine is initialized.
*
* \return 1 on success
Modified: grass/trunk/lib/gis/icon.c
===================================================================
--- grass/trunk/lib/gis/icon.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/icon.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file icon.c
*
- * \brief Plot icon
+ * \brief GIS Library - Plot icon
*
+ * (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 1999-2007
+ * \date 1999-2008
*/
#include <stdlib.h>
@@ -37,16 +39,14 @@
}
/**
- * \fn G_plot_icon (double xc, double yc, int type, double angle, double scale)
- *
* \brief Plot icon
*
- * \return 1
- *
* \param[in] xc,yc icon coordinates
* \param[in] type icon type
* \param[in] angle rotation angle [rad]
* \param[in] scale scale factor
+ *
+ * \return 1
*/
int G_plot_icon (double xc, double yc, int type, double angle, double scale)
{
Modified: grass/trunk/lib/gis/is.c
===================================================================
--- grass/trunk/lib/gis/is.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/is.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file is.c
*
- * \brief Tests for file existence.
+ * \brief GIS Library - Tests for file existence.
*
+ * (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 2001-2006
+ * \date 2001-2008
*/
#include <stdio.h>
@@ -38,8 +40,7 @@
/**
- * \fn int G_is_gisbase (const char *path)
- *
+
* \brief Test if specified directory is GISBASE.
*
* \param[in] path Path to directory
@@ -54,8 +55,6 @@
/**
- * \fn int G_is_location (const char *path)
- *
* \brief Test if specified directory is location.
*
* \param[in] path Path to directory
@@ -70,8 +69,6 @@
/**
- * \fn int G_is_mapset (const char *path)
- *
* \brief Test if specified directory is mapset.
*
* \param[in] path Path to directory
Modified: grass/trunk/lib/gis/legal_name.c
===================================================================
--- grass/trunk/lib/gis/legal_name.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/legal_name.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,8 +1,10 @@
/**
* \file legal_name.c
*
- * \brief Functions to handle file name legality.
+ * \brief GIS Library - Functions to handle file name legality.
*
+ * (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.
*
@@ -18,8 +20,6 @@
/**
- * \fn int G_legal_filename (char *s)
- *
* \brief Check for legal database file name.
*
* Legal file names will <b>not</b> begin with '.' or NULL and must
@@ -51,8 +51,6 @@
/**
- * \fn int G_check_input_output_name (char * input, char * output, int error)
- *
* \brief Check input and output file names.
*
* Check: 1) output is legal map name, 2) if can find input map, and 3)
@@ -72,9 +70,9 @@
if ( output == NULL) return 0; /* don't die on undefined parameters */
if ( G_legal_filename(output) == -1 ) {
if ( error == GR_FATAL_EXIT ) {
- G_fatal_error ( _("Output name '%s' is not valid rast name."), output );
+ G_fatal_error ( _("Output raster map name <%s> is not valid map name"), output );
} else if ( error == GR_FATAL_PRINT ) {
- G_warning ( _("Output name '%s' is not valid rast name."), output );
+ G_warning ( _("Output raster map name <%s> is not valid map name"), output );
return 1;
} else { /* GR_FATAL_RETURN */
return 1;
@@ -85,9 +83,9 @@
if ( mapset == NULL ) {
if ( error == GR_FATAL_EXIT ) {
- G_fatal_error ( _("Cannot find input map '%s'"), input );
+ G_fatal_error ( _("Raster map <%s> not found"), input );
} else if ( error == GR_FATAL_PRINT ) {
- G_warning ( _("Cannot find input map '%s'"), input );
+ G_warning ( _("Raster map <%s> not found"), input );
return 1;
} else { /* GR_FATAL_RETURN */
return 1;
@@ -106,9 +104,9 @@
if ( strcmp(in,output) == 0 ) {
if ( error == GR_FATAL_EXIT ) {
- G_fatal_error ( _("Output map '%s' is used as input"), output );
+ G_fatal_error ( _("Output raster map <%s> is used as input"), output );
} else if ( error == GR_FATAL_PRINT ) {
- G_warning ( _("Output map '%s' is used as input"), output );
+ G_warning ( _("Output raster map <%s> is used as input"), output );
return 1;
} else { /* GR_FATAL_RETURN */
return 1;
Modified: grass/trunk/lib/gis/locale.c
===================================================================
--- grass/trunk/lib/gis/locale.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/locale.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file locale.c
*
- * \brief Functions to handle locale.
+ * \brief GIS Library - Functions to handle locale.
*
+ * (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 2004-2006
+ * \date 2004-2008
*/
#include <grass/config.h>
@@ -41,8 +43,6 @@
/**
- * \fn char *G_gettext (const char *package, const char *msgid)
- *
* \brief Gets localized text.
*
* \param[in] package
Modified: grass/trunk/lib/gis/maskfd.c
===================================================================
--- grass/trunk/lib/gis/maskfd.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/maskfd.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file maskfd.c
*
- * \brief Mask functions.
+ * \brief GIS Library - Mask functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
@@ -16,8 +18,6 @@
/**
- * \fn int G_maskfd (void)
- *
* \brief Test for MASK.
*
* \return -1 if no MASK
Modified: grass/trunk/lib/gis/myname.c
===================================================================
--- grass/trunk/lib/gis/myname.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/myname.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file myname.c
*
- * \brief Database name functions.
+ * \brief GIS Library - Database name functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <string.h>
@@ -17,8 +19,6 @@
/**
- * \fn char *G_myname ()
- *
* \brief Returns location title.
*
* Returns a one line title for the database location. This title is
Modified: grass/trunk/lib/gis/overwrite.c
===================================================================
--- grass/trunk/lib/gis/overwrite.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/overwrite.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,19 +1,23 @@
/**
* \file overwrite.c
*
- * \brief Check for overwrite.
+ * \brief GIS Library - Check for overwrite.
*
+ * (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, Martin Landa <landa.martin gmail.com>
*
- * \date 2007
+ * \date 2007-2008
*/
+#include <stdlib.h>
+#include <string.h>
+#include <grass/gis.h>
+
/**
- * \fn G_check_overwrite(int argc, char **argv)
- *
* \brief Check for overwrite mode
*
* Check variables OVERWRITE, GRASS_OVERWRITE and '--o' flag.
@@ -22,16 +26,13 @@
* we can switch out the check and do it
* in the module after the parser.
*
- * \param[in] argc
- * \param[in] argv
+ * \param[in] argc number of arguments
+ * \param[in] argv array of arguments
*
- * \return 1 if overwrite; 0 if not overwrite
+ * \return 1 if overwrite
+ * \return 0 if not overwrite
*/
-#include <stdlib.h>
-#include <string.h>
-#include <grass/gis.h>
-
int G_check_overwrite(int argc, char **argv)
{
char *overstr;
Modified: grass/trunk/lib/gis/parser.c
===================================================================
--- grass/trunk/lib/gis/parser.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/parser.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,20 +1,8 @@
/**
* \file parser.c
*
- * \brief GIS library - Argument parsing functions.
+ * \brief GIS Library - Argument parsing functions.
*
- * \author Radim Blazek
- *
- * \date 2003-2008 (C) 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.
- */
-
-/***************************************************************************
- * Routines used to assist in command line parsing.
- ***************************************************************************
- *
* Parses the command line provided through argc and argv. Example:
* Assume the previous calls:
*
@@ -66,8 +54,16 @@
* that the "map" option is required and also that the number 12 is
* out of range. The acceptable range (or list) will be printed.
*
- ***************************************************************************
-*/
+ * (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 Radim Blazek
+ *
+ * \date 2003-2008
+ *
+ */
#include <grass/config.h>
@@ -146,8 +142,6 @@
/**
- * \fn int G_disable_interactive (void)
- *
* \brief Disables the ability of the parser to operate interactively.
*
* When a user calls a command with no arguments on the command line,
@@ -169,8 +163,6 @@
/**
- * \fn struct Flag *G_define_flag (void)
- *
* \brief Initializes a Flag struct.
*
* Allocates memory for the Flag structure and returns a pointer to this
@@ -180,7 +172,7 @@
* at the command line using a minus sign followed by the character
* representing the flag.
*
- * \retval Flag * Pointer to a Flag struct
+ * \return Flag * Pointer to a Flag struct
*/
struct Flag *
@@ -227,8 +219,6 @@
/**
- * \fn struct Option *G_define_option (void)
- *
* \brief Initializes an Option struct.
*
* Allocates memory for the Option structure and returns a pointer to
@@ -241,7 +231,7 @@
* values (e.g. "red,orange,yellow"). Unless the option string is NULL,
* user provided input will be evaluated agaist this string.
*
- * \retval Option * Pointer to an Option struct
+ * \return Option * Pointer to an Option struct
*/
struct Option *
@@ -302,8 +292,6 @@
/**
- * \fn struct Option *G_define_standard_option (int opt)
- *
* \brief Create standardised Option structure.
*
* This function will create a standardised Option structure
@@ -314,19 +302,19 @@
* If an invalid parameter was specified a empty Option structure will
* be returned (not NULL).
*
- * - general: G_OPT_WHERE, G_OPT_COLUMN, G_OPT_COLUMNS, G_OPT_TABLE, G_OPT_DRIVER, G_OPT_DATABASE
+ * - general: G_OPT_WHERE, G_OPT_COLUMN, G_OPT_COLUMNS, G_OPT_TABLE, G_OPT_DRIVER, G_OPT_DATABASE
*
- * - imagery: G_OPT_I_GROUP, G_OPT_I_SUBGROUP
+ * - imagery: G_OPT_I_GROUP, G_OPT_I_SUBGROUP
*
- * - raster: G_OPT_R_INPUT, G_OPT_R_INPUTS, G_OPT_R_OUTPUT, G_OPT_R_MAP, G_OPT_R_MAPS, G_OPT_R_BASE, G_OPT_R_COVER, G_OPT_R_ELEV, G_OPT_R_ELEVS
+ * - raster: G_OPT_R_INPUT, G_OPT_R_INPUTS, G_OPT_R_OUTPUT, G_OPT_R_MAP, G_OPT_R_MAPS, G_OPT_R_BASE, G_OPT_R_COVER, G_OPT_R_ELEV, G_OPT_R_ELEVS
*
- * - raster3d: G_OPT_R3_INPUT, G_OPT_R3_INPUTS, G_OPT_R3_OUTPUT, G_OPT_R3_MAP, G_OPT_R3_MAPS
+ * - raster3d: G_OPT_R3_INPUT, G_OPT_R3_INPUTS, G_OPT_R3_OUTPUT, G_OPT_R3_MAP, G_OPT_R3_MAPS
*
- * - vector: G_OPT_V_INPUT, G_OPT_V_INPUTS, G_OPT_V_OUTPUT, G_OPT_V_MAP, G_OPT_V_MAPS, G_OPT_V_TYPE, G_OPT_V_FIELD, G_OPT_V_CAT, G_OPT_V_CATS
+ * - vector: G_OPT_V_INPUT, G_OPT_V_INPUTS, G_OPT_V_OUTPUT, G_OPT_V_MAP, G_OPT_V_MAPS, G_OPT_V_TYPE, G_OPT_V_FIELD, G_OPT_V_CAT, G_OPT_V_CATS
*
* \param[in] opt Type of Option struct to create
*
- * \retval Option * Pointer to an Option struct
+ * \return Option * Pointer to an Option struct
*/
struct Option *
@@ -657,11 +645,9 @@
/**
- * \fn struct GModule *G_define_module (void)
- *
* \brief Initializes a new module.
*
- * \retval GModule * Pointer to a GModule struct
+ * \return GModule * Pointer to a GModule struct
*/
struct GModule *
@@ -683,8 +669,6 @@
/* The main parsing routine */
/**
- * \fn int G_parser (int argc, char **argv)
- *
* \brief Parse command line.
*
* The command line parameters <b>argv</b> and the number of parameters
@@ -1025,8 +1009,6 @@
/**
- * \fn int G_usage (void)
- *
* \brief Command line help/usage message.
*
* Calls to <i>G_usage()</i> allow the programmer to print the usage
@@ -1228,8 +1210,6 @@
/**
- * \fn void print_escaped_for_xml (FILE * fp, const char * str)
- *
* \brief Formats text for XML.
*
* \param[in,out] fp file to write to
@@ -2850,14 +2830,12 @@
}
/**
- * \fn char *G_recreate_command (void)
- *
* \brief Creates command to run non-interactive.
*
* Creates a command-line that runs the current command completely
* non-interactive.
*
- * \retval char * Pointer to a char string
+ * \return char * Pointer to a char string
*/
char *G_recreate_command (void)
{
Modified: grass/trunk/lib/gis/percent.c
===================================================================
--- grass/trunk/lib/gis/percent.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/percent.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file percent.c
*
- * \brief Percentage progress functions.
+ * \brief GIS Library - percentage progress functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdio.h>
@@ -20,8 +22,6 @@
/**
- * \fn int G_percent (long n, long d, int s)
- *
* \brief Print percent complete messages.
*
* This routine prints a percentage complete message to stderr. The
@@ -59,8 +59,6 @@
/**
- * \fn int G_percent2 (long n, long d, int s, FILE *out)
- *
* \brief Print percent complete messages.
*
* This routine prints a percentage complete message to stderr. The
@@ -141,8 +139,6 @@
/**
- * \fn int G_percent_reset (void)
- *
* \brief Reset G_percent() to 0%; do not add newline.
*
* \return always returns 0
Modified: grass/trunk/lib/gis/remove.c
===================================================================
--- grass/trunk/lib/gis/remove.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/remove.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file remove.c
*
- * \brief File remove functions.
+ * \brief GIS Library - File remove functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/config.h>
@@ -25,8 +27,6 @@
static int G__remove (int misc, const char *dir, const char *element, const char *name);
/**
- * \fn int G_remove (char *element, char *name)
- *
* \brief Remove a database file.
*
* The file or directory <b>name</b> under the database <b>element</b> directory
@@ -35,8 +35,8 @@
* <b>Note:</b> If <b>name</b> is a directory, everything within the
* directory is removed as well.
*
- * \param[in] element
- * \param[in] name
+ * \param[in] element element name
+ * \param[in] name file nane
* \return 0 if <b>name</b> does not exist
* \return 1 if successful
* \return -1 on error
@@ -47,6 +47,21 @@
return G__remove(0, NULL, element, name);
}
+/**
+ * \brief Remove a database misc file.
+ *
+ * The file or directory <b>name</b> under the database <b>element</b> directory
+ * in the current mapset is removed.<br>
+ *
+ * <b>Note:</b> If <b>name</b> is a directory, everything within the
+ * directory is removed as well.
+ *
+ * \param[in] element element name
+ * \param[in] name file name
+ * \return 0 if <b>name</b> does not exist
+ * \return 1 if successful
+ * \return -1 on error
+ */
int G_remove_misc (const char *dir, const char *element, const char *name)
{
return G__remove(1, dir, element, name);
Modified: grass/trunk/lib/gis/rename.c
===================================================================
--- grass/trunk/lib/gis/rename.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/rename.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,8 +1,10 @@
/**
* \file rename.c
*
- * \brief Rename file functions.
+ * \brief GIS Library - Rename file functions.
*
+ * (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.
*
@@ -19,13 +21,10 @@
/**
- **\fn int G_rename_file (char *oldname, char *newname)
- **
**\brief Rename a file in the filesystem.
**
**The file or directory <b>oldname</b> is renamed to <b>newname</b>.<br>
**
- **
** \param[in] oldname
** \param[in] newname
** \return 0 if successful
@@ -43,8 +42,6 @@
}
/**
- * \fn int G_rename (char *element, char *oldname, char *newname)
- *
* \brief Rename a database file.
*
* The file or directory <b>oldname</b> under the database <b>element</b>
Modified: grass/trunk/lib/gis/rhumbline.c
===================================================================
--- grass/trunk/lib/gis/rhumbline.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/rhumbline.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,7 +1,7 @@
/**
* \file rhumbline.c
*
- * \brief Rhumbline calculation routines.
+ * \brief GIS Library - Rhumbline calculation routines.
*
* From "Map Projections" by Peter Richardus and Ron K. Alder, 1972<br>
* (526.8 R39m in Map & Geography Library)<br>
@@ -16,12 +16,14 @@
* <br>
* <b>WARNING:</b> This code is preliminary. It may not even be correct.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <math.h>
@@ -39,17 +41,13 @@
/**
- * \fn int G_begin_rhumbline_equation (double lon1, double lat1, double lon2, double lat2)
- *
* \brief Start rhumbline calculations.
*
* <b>Note:</b> This function must be called before other rhumbline
* functions to initialize parameters.
*
- * \param[in] lon1 first longitude
- * \param[in] lat1 first latitude
- * \param[in] lon2 second longitude
- * \param[in] lat2 second latitude
+ * \param[in] lon1,lat1 longitude, latitude of first point
+ * \param[in] lon2,lat2 longitude, latitude of second point
* \return 1 on success
* \return 0 on error
*/
@@ -88,8 +86,6 @@
/**
- * \fn double G_rhumbline_lat_from_lon (double lon)
- *
* \brief Calculates rhumbline latitude.
*
* <b>Note:</b> Function only works if lon1 < lon < lon2.
Modified: grass/trunk/lib/gis/rotate.c
===================================================================
--- grass/trunk/lib/gis/rotate.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/rotate.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,11 +1,15 @@
-/* rotate.c
+/*!
+ * \file rotate.c
*
- * Copyright (C) 2007 by Hamish Bowman, Glynn Clements
- * Author(s): Hamish Bowman, Glynn Clements
+ * \brief GIS Library - rotate
*
- * This program is free software under the GNU General Public
- * License (>=v2). Read the file COPYING that comes with GRASS
- * for details.
+ * (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 Hamish Bowman, Glynn Clements
*/
#include <math.h>
@@ -17,17 +21,16 @@
/*!
- * \fn void G_rotate_around_point(double, double, double*, double*, double)
+ * \brief Rotate point (double version)
*
- * \desc given a point, angle, and origin, rotate the point around the origin
+ * Given a point, angle, and origin, rotate the point around the origin
* by the given angle. Coordinates and results are double prec floating point.
*
* \param X0 X component of origin (center of circle)
* \param Y0 Y component of origin (center of circle)
- * \param X1 X component of point to be rotated (variable is modified!)
- * \param Y1 Y component of point to be rotated (variable is modified!)
+ * \param[out] X1 X component of point to be rotated (variable is modified!)
+ * \param[out] Y1 Y component of point to be rotated (variable is modified!)
* \param angle in degrees, measured CCW from east
- * \return void
*/
void G_rotate_around_point(double X0, double Y0, double *X1, double *Y1, double angle)
{
@@ -42,21 +45,18 @@
*Y1 = Y0 + dy1;
}
-
-
/*!
- * \fn void G_rotate_around_point_int(int, int, int*, int*, double)
+ * \brief Rotate point (int version)
*
- * \desc given a point, angle, and origin, rotate the point around the origin
+ * Given a point, angle, and origin, rotate the point around the origin
* by the given angle. Coordinates are given in integer and results are rounded
* back to integer.
*
* \param X0 X component of origin (center of circle)
* \param Y0 Y component of origin (center of circle)
- * \param X1 X component of point to be rotated (variable is modified!)
- * \param Y1 Y component of point to be rotated (variable is modified!)
+ * \param[out] X1 X component of point to be rotated (variable is modified!)
+ * \param[out] Y1 Y component of point to be rotated (variable is modified!)
* \param angle in degrees, measured CCW from east
- * \return void
*/
void G_rotate_around_point_int(int X0, int Y0, int *X1, int *Y1, double angle)
{
Modified: grass/trunk/lib/gis/set_window.c
===================================================================
--- grass/trunk/lib/gis/set_window.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/set_window.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -3,6 +3,8 @@
*
* \brief Set window
*
+ * (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.
*
@@ -16,16 +18,13 @@
#include "G.h"
/**
- * \fn int G_get_set_window (struct Cell_head *window)
- *
* \brief Get the current working window.
*
* The current working window values are returned in the structure
* 'window'.
*
- * \return 1
- *
* \param[out] window window structure to be set
+ * \return 1
*/
int G_get_set_window (struct Cell_head *window)
{
@@ -37,16 +36,14 @@
/**
- * \fn int G_set_window (struct Cell_head *window)
- *
* \brief Establishes 'window' as the current working window.
*
* Any opened cell files has its file-to-window mapping reworked.
*
+ * \param[in] window window to become operative window
+ *
* \return -1 on error
* \return 1 on success
- *
- * \param[in] window window to become operative window
*/
int G_set_window (struct Cell_head *window)
{
Modified: grass/trunk/lib/gis/short_way.c
===================================================================
--- grass/trunk/lib/gis/short_way.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/short_way.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file short_way.c
*
- * \brief Shortest path functions.
+ * \brief GIS Library - Shortest path functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_shortest_way (double *east1, double *east2)
- *
* \brief Shortest way between two eastings.
*
* For lat-lon projection (<i>PROJECTION_LL</i>), <b>east1</b>,
@@ -24,8 +24,8 @@
* apart. Their true locations are not changed. For all other
* projections, this function does nothing.
*
- * \param[in] east1
- * \param[in] east2
+ * \param[in] east1 east (x) coordinate of first point
+ * \param[in] east2 east (x) coordinate of second point
* \return always returns 0
*/
Modified: grass/trunk/lib/gis/snprintf.c
===================================================================
--- grass/trunk/lib/gis/snprintf.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/snprintf.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,22 @@
/**
* \file snprintf.c
*
- * \brief snprintf() clone functions.
+ * \brief GIS Library - snprintf() clone functions.
*
+ *
+ * \todo if needed, implement alternative versions for portability.
+ * potential code source:
+ * - http://www.ijs.si/software/snprintf/
+ * - openssh's snprintf() implementation: bsd-snprintf.c
+ *
+ * (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 Markus Neteler
*
- * \date 2006
+ * \date 2006-2008
*/
#include <stdio.h>
@@ -18,19 +26,9 @@
#include <assert.h>
#include <grass/gis.h>
-
-/* TODO: if needed, implement alternative versions for portability.
- potential code source:
- - http://www.ijs.si/software/snprintf/
- - openssh's snprintf() implementation: bsd-snprintf.c
- */
-
/* #ifdef HAVE_SNPRINTF */
-
/**
- * \fn int G_snprintf(char *str, size_t size, const char *fmt, ...)
- *
* \brief snprintf() clone.
*
* <b>Note:</b> The use of <i>snprintf()</i>/<i>G_snprintf()</i> is
Modified: grass/trunk/lib/gis/spawn.c
===================================================================
--- grass/trunk/lib/gis/spawn.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/spawn.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,8 +1,10 @@
/**
* \file spawn.c
*
- * \brief Handles process spawning.
+ * \brief GIS Library - Handles process spawning.
*
+ * (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.
*
@@ -40,8 +42,6 @@
/**
- * \fn int G_spawn (char *command, ...)
- *
* \brief Spawns a new process.
*
* A more useful alternative to G_system(), which takes the
@@ -603,6 +603,16 @@
}
}
+/**
+ * \brief Spawn new process based on <b>command</b>.
+ *
+ * This is a more advanced version of G_spawn().
+ *
+ * \param[in] command
+ * \param[in] args arguments
+ * \return -1 on error
+ * \return process status on success
+ */
int G_vspawn_ex(const char *command, const char **args)
{
begin_spawn();
@@ -613,8 +623,6 @@
}
/**
- * \fn int G_spawn_ex(char *command, ...)
- *
* \brief Spawn new process based on <b>command</b>.
*
* This is a more advanced version of G_spawn().
Modified: grass/trunk/lib/gis/squeeze.c
===================================================================
--- grass/trunk/lib/gis/squeeze.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/squeeze.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file squeeze.c
*
- * \brief String white space removal functions.
+ * \brief GIS Library - String white space removal functions.
*
+ * (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 1998-2006
+ * \date 1998-2008
*/
#include <ctype.h>
@@ -28,8 +30,6 @@
/**
- * \fn char *G_squeeze (char *line)
- *
* \brief Remove superfluous white space.
*
* Leading and trailing white space is removed from the string
Modified: grass/trunk/lib/gis/store.c
===================================================================
--- grass/trunk/lib/gis/store.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/store.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file store.c
*
- * \brief String storage functions.
+ * \brief GIS Library - String storage functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
@@ -16,16 +18,14 @@
/**
- * \fn char *G_store (const char *s)
- *
* \brief Copy string to allocated memory.
*
* This routine allocates enough memory to hold the string <b>s</b>,
* copies <b>s</b> to the allocated memory, and returns a pointer
* to the allocated memory.
*
- * \param[in] s
- * \return char *
+ * \param[in] s string
+ * \return pointer to newly allocated string
*/
char *G_store (const char *s)
Modified: grass/trunk/lib/gis/strings.c
===================================================================
--- grass/trunk/lib/gis/strings.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/strings.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,10 +1,12 @@
/*!
* \file strings.c
*
- * \brief string/chring movement functions
+ * \brief GIS Library - string/chring movement functions
*
- * (C) 1999-2007 by the GRASS Development Team
+ * \todo merge interesting functions from ../datetime/scan.c here
*
+ * (C) 1999-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.
@@ -14,67 +16,6 @@
* many others
*/
-/* TODO: merge interesting functions from
- ../datetime/scan.c
- here
-*/
-
-/*
- * string/chring movement functions
- *
-** G_strcpy (T, F)
-** G_strncpy (T, F, n) copy F up to null or n, always copy null
-** G_chrcpy (T, F, n)
-** G_strmov (T, F)
-** G_chrmov (T, F, n)
-** G_strcat (T, F)
-** G_chrcat (T, F, n)
-** char *T, *F;
-** int n;
- *
- * G_strcpy (T, F) copy F up to null, copy null
- * G_chrcpy (T, F, n) copy F up to n, copy null
- *
- * G_strmov (T, F) copy F up to null
- * G_chrmov (T, F, n) copy F up to n
- *
- * G_strcat (T, F) cat F up to null, copy null
- * G_chrcat (T, F, n) cat F up to n, copy null
- *
- * the -cpy and -cat functions are for null-terminated destinations;
- * the -mov functions are for non-null-terminated ('chring') destinations.
- * all functions return 'T'.
- *
- * Author Dave Gerdes (USACERL)
- *
- *
- * G_strcasecmp(a, b) char *a, *b;
- * string compare ignoring case (upper or lower)
- * returns: -1 a<b; 0 a==b; 1 a>b
- *
- * Author Michael Shapiro (USACERL)
- *
- *
- * G_strstr(mainString, subString)
- * Return a pointer to the first occurrence of subString
- * in mainString, or NULL if no occurrences are found.
- * G_strdup(string)
- * Return a pointer to a string that is a duplicate of the string
- * given to G_strdup. The duplicate is created using malloc.
- * If unable to allocate the required space, NULL is returned.
- *
- * Author: Amit Parghi (USACERL), 1993 02 23
- *
- * G_strchg(char* bug, char character, char new) {
- * replace all occurencies of character in string(inplace) with new
- *
- * Author: Bernhard Reiter (Intevation GmbH, Germany)
- *
- * char * G_str_replace(char* buffer, char* old_str, char* new_str)
- * Replace all occurencies of old_str in buffer with new_str
- * Author Beverly Wallace (LMCO)
- */
-
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
@@ -93,16 +34,14 @@
}
/*!
- * \fn char *G_strcpy (char *T, const char *F)
- *
* \brief Copies characters from the string F into the string T.
*
* This function has undefined results if the strings overlap.
*
- * \return T value
- *
* \param[out] T target string
* \param[in] F source string
+ *
+ * \return pointer to T
*/
char *G_strcpy (char *T, const char *F)
{
@@ -114,19 +53,16 @@
}
/*!
- * \fn char *G_chrcpy (char *T, const char *F, int n)
- *
* \brief Copies characters from the string F into the string T.
*
* Copies just the first n characters from the string F. At the end
* the null terminator is written into the string T.
*
- *
- * \return T value
- *
* \param[out] T target string
* \param[in] F source string
* \param[in] n number of characters to copy
+ *
+ * \return T value
*/
char *G_chrcpy (char *T, const char *F, int n)
{
@@ -139,8 +75,6 @@
}
/*!
- * \fn char *G_strncpy (char *T, const char *F, int n)
- *
* \brief This function is similar to G_chrcpy() but always copies at least
* n characters into the string T.
*
@@ -148,11 +82,11 @@
* characters. At the end the null terminator is written into the
* string T.
*
- * \return T value
- *
* \param[out] T target string
* \param[in] F source string
* \param[in] n number of characters to copy
+ *
+ * \return T value
*/
char *G_strncpy (char *T, const char *F, int n)
{
@@ -165,15 +99,13 @@
}
/*!
- * \fn char *G_strmov (char *T, const char *F)
- *
* \brief Copies characters from the string F (not including the
* terminating null character) into the string T.
*
- * \return T value
- *
* \param[out] T target string
* \param[in] F source string
+ *
+ * \return T value
*/
char *G_strmov (char *T, const char *F)
{
@@ -185,19 +117,17 @@
}
/*!
- * \fn char *G_chrmov (char *T, const char *F, int n)
- *
* \brief This copies characters from the string F (exactly n
* characters) into the string T.
*
* The terminating null character is not explicitly written into the
* string T.
*
- * \return T value
- *
* \param[out] T target string
* \param[in] F source string
* \param[in] n number of characters to copy
+ *
+ * \return T value
*/
char *G_chrmov (char *T, const char *F, int n)
{
@@ -209,8 +139,6 @@
}
/*!
- * \fn char *G_strcat (char *T, const char *F)
- *
* \brief This copies characters from the string F into the string T.
*
* This function is similar to G_strcpy(), except that the
@@ -218,10 +146,10 @@
* T, instead of overwriting it. That is, the first character from
* F overwrites the null character marking the end of T.
*
- * \return T value
- *
* \param[out] T target string
* \param[in] F source string
+ *
+ * \return T value
*/
char *G_strcat (char *T, const char *F)
{
@@ -230,8 +158,6 @@
}
/*!
- * \fn char *G_chrcat (char *T, const char *F, int n)
- *
* \brief This function is like G_strcat() except that not more than n
* characters from F are appended to the end of T.
*
@@ -240,11 +166,11 @@
* T, instead of overwriting it. That is, the first character from
* F overwrites the null character marking the end of T.
*
- * \return T value
- *
* \param[out] T target string
* \param[in] F source string
* \param[in] n number of character to copy
+ *
+ * \return T value
*/
char *G_chrcat (char *T, const char *F, int n)
{
@@ -253,18 +179,16 @@
}
/*!
- * \fn int G_strcasecmp(const char *x, const char *y)
- *
* \brief String compare ignoring case (upper or lower)
*
* Returning a value that has the same sign as the difference between
* the first differing pair of characters
*
- * \return 0 the two strings are equal
- * \return -1, 1
- *
* \param[in] x first string to compare
* \param[in] y second string to compare
+ *
+ * \return 0 the two strings are equal
+ * \return -1, 1
*/
int G_strcasecmp(const char *x, const char *y)
{
@@ -291,17 +215,15 @@
}
/*!
- * \fn char *G_strstr(char *mainString, const char *subString)
- *
* \brief Finds the first occurrence of the character C in the
* null-terminated string beginning at mainString
*
+ * \param[in] mainString string where to find sub-string
+ * \param[in] subString sub-string
+ *
* \return a pointer to the first occurrence of subString in
* mainString
* \return NULL if no occurrences are found
- *
- * \param[in] mainString string where to find sub-string
- * \param[in] subString sub-string
*/
char *G_strstr(const char *mainString, const char *subString)
{
@@ -328,16 +250,14 @@
}
/*!
- * \fn char *G_strdup(const char *string)
- *
* \brief Copies the null-terminated string into a newly
* allocated string. The string is allocated using G_malloc().
*
+ * \param[in] string the string to duplicate
+ *
* \return pointer to a string that is a duplicate of the string
* given to G_strdup().
* \return NULL if unable to allocate the required space
- *
- * \param[in] string the string to duplicate
*/
char *G_strdup(const char *string)
{
@@ -353,15 +273,13 @@
}
/*!
- * \fn char *G_strchg(char* bug, char character, char new)
- *
* \brief Replace all occurencies of character in string bug with new
*
- * \return bug string
- *
* \param[in,out] bug base string
* \param[in] character character to replace
* \param[in] new new character
+ *
+ * \return bug string
*/
char *G_strchg(char* bug, char character, char new)
{
@@ -375,23 +293,21 @@
}
/*!
- * \fn char *G_str_replace(char* buffer, const char* old_str, const char* new_str)
- *
* \brief Replace all occurencies of old_str in buffer with new_str
*
* Code example:
- * \verbatim
+ * \code
* char *name;
* name = G_str_replace ( inbuf, ".exe", "" );
* ...
* G_free (name);
- * \endverbatim
+ * \endcode
*
- * \return the newly allocated string, input buffer is unchanged
- *
* \param[in,out] buffer main string
* \param[in] old_str string to replace
* \param[in] new_str new string
+ *
+ * \return the newly allocated string, input buffer is unchanged
*/
char *G_str_replace(char* buffer, const char* old_str, const char* new_str)
{
@@ -460,14 +376,11 @@
}
/*!
- * \fn int G_strip(register char *buf)
- *
* \brief Removes all leading and trailing white space from string.
*
- * \return 0
- *
* \param[in,out] buf buffer to be worked on
*
+ * \return 0
*/
int G_strip (char *buf)
{
@@ -494,25 +407,14 @@
}
/*!
- * \fn char *G_chop (char *line)
- *
* \brief Chop leading and trailing white spaces:
* \verbatim space, \f, \n, \r, \t, \v \endverbatim
*
- * \return pointer to string
+ * modified copy of G_squeeze(); RB March 2000 <Radim.Blazek at dhv.cz>
*
* \param line buffer to be worked on
- */
-/*
- * G_chop - chop leading and trailing white spaces:
- * space, \f, \n, \r, \t, \v
- * - returns pointer to string
- *
- * char *G_chop (char *s)
*
- * modified copy of G_squeeze(); RB March 2000
- * <Radim.Blazek at dhv.cz>
- *
+ * \return pointer to string
*/
char *G_chop (char *line)
{
@@ -542,8 +444,6 @@
}
/*!
- * \fn void G_str_to_upper (char *str)
- *
* \brief Convert string to upper case
*
* \param[in,out] str pointer to string
@@ -562,8 +462,6 @@
}
/*!
- * \fn void G_str_to_lower (char *str)
- *
* \brief Convert string to lower case
*
* \param[in,out] str pointer to string
@@ -582,13 +480,11 @@
}
/*!
- * \fn int G_str_to_sql (char *str)
- *
* \brief Make string SQL compliant
*
- * \return number of changed characters
- *
* \param[in,out] str pointer to string
+ *
+ * \return number of changed characters
*/
int G_str_to_sql (char *str)
{
Modified: grass/trunk/lib/gis/system.c
===================================================================
--- grass/trunk/lib/gis/system.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/system.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file system.c
*
- * \brief Command execution functions.
+ * \brief GIS Library - Command execution functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/config.h>
@@ -25,8 +27,6 @@
/**
- * \fn int G_system (char *command)
- *
* \brief Run a shell level command.
*
* This is essentially the UNIX <i>system()</i> call, except for the
Modified: grass/trunk/lib/gis/tempfile.c
===================================================================
--- grass/trunk/lib/gis/tempfile.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/tempfile.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file tempfile.c
*
- * \brief Temporary file functions.
+ * \brief GIS Library - Temporary file functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <string.h>
@@ -18,8 +20,6 @@
/**
- * \fn char *G_tempfile (void)
- *
* \brief Returns a temporary file name.
*
* This routine returns a pointer to a string containing a unique
@@ -50,8 +50,6 @@
/**
- * \fn char *G__tempfile (int pid)
- *
* \brief Create tempfile from process id.
*
* See <i>G_tempfile()</i>.
@@ -83,8 +81,6 @@
/**
- * \fn int G__temp_element (char *element)
- *
* \brief Populates <b>element</b> with a path string.
*
* \param[in,out] element
Modified: grass/trunk/lib/gis/token.c
===================================================================
--- grass/trunk/lib/gis/token.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/token.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file token.c
*
- * \brief Token functions.
+ * \brief GIS Library - Token functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdlib.h>
@@ -16,8 +18,6 @@
/**
- * \fn char **G_tokenize (char *buf, char *delim)
- *
* \brief Tokenize string.
*
* Given a string, <b>buf</b>, turn delimiter, <b>delim</b>, into '\0'
@@ -65,8 +65,6 @@
/**
- * \fn int G_number_of_tokens (char **tokens)
- *
* \brief Return number of tokens.
*
* <b>Note:</b> Function is incomplete.
@@ -89,8 +87,6 @@
/**
- * \fn int G_free_tokens (char **tokens)
- *
* \brief Free memory allocated to tokens.
*
* <b>Note:</b> <i>G_free_tokens()</i> must be called when finished with
Modified: grass/trunk/lib/gis/trim_dec.c
===================================================================
--- grass/trunk/lib/gis/trim_dec.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/trim_dec.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file trim_dec.c
*
- * \brief Trim string decimal functions.
+ * \brief GIS Library - Trim string decimal functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_trim_decimal (char *buf)
- *
* \brief Removes trailing zeros from decimal number.
*
* Example: 23.45000 would come back as 23.45
Modified: grass/trunk/lib/gis/unctrl.c
===================================================================
--- grass/trunk/lib/gis/unctrl.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/unctrl.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,8 +1,10 @@
/**
* \file unctrl.c
*
- * \brief Handles control characters.
+ * \brief GIS Library - Handles control characters.
*
+ * (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.
*
@@ -16,8 +18,6 @@
/**
- * \fn char *G_unctrl (int c)
- *
* \brief Printable version of control character.
*
* This routine returns a pointer to a string which contains an
@@ -27,7 +27,7 @@
* represented by DEL/RUB. Normal characters remain unchanged.
*
* \param[in] int c
- * \retval char * pointer to string containing English-like representation for character <b>c</b>
+ * \return char * pointer to string containing English-like representation for character <b>c</b>
*/
char *G_unctrl (int c)
Modified: grass/trunk/lib/gis/unix_socks.c
===================================================================
--- grass/trunk/lib/gis/unix_socks.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/unix_socks.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,7 +1,7 @@
/**
* \file unix_sockets.c
*
- * \brief Unix sockets support functions.
+ * \brief GIS Library - Unix sockets support functions.
*
* Routines related to using UNIX domain sockets for IPC mechanisms
* (such as XDRIVER).<br>
@@ -16,20 +16,20 @@
* <b>Note:</b> This implementation of UNIX sockets provides zero
* security checking so should not be used from untrusted clients.<br>
*
+ * (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 Eric G. Miller
*
- * \date 1999-2006
+ * \date 1999-2008
*/
#include <grass/config.h>
#ifdef HAVE_SOCKET
-#include <grass/gis.h>
-#include <grass/version.h>
#include <stdio.h>
#include <stddef.h>
#include <stdlib.h>
@@ -50,6 +50,10 @@
#define INVALID_SOCKET (-1)
#endif
+#include <grass/gis.h>
+#include <grass/version.h>
+#include <grass/glocale.h>
+
/** For systems where the *_LOCAL (POSIX 1g) is not defined
** There's not really any difference between PF and AF in practice.
**/
@@ -96,7 +100,7 @@
}
if ( (lock = getenv ( "GIS_LOCK" )) == NULL )
- G_fatal_error ("Cannot get GIS_LOCK enviroment variable value");
+ G_fatal_error (_("Unable to get GIS_LOCK enviroment variable value"));
len = strlen(prefix) + strlen(user) + strlen(lock) + 3;
path = G_malloc (len);
@@ -212,8 +216,6 @@
#endif
/**
- * \fn char *G_sock_get_fname (const char *name)
- *
* \brief Builds full path for a UNIX socket.
*
* Caller should <i>G_free()</i> the return value when it is no longer
@@ -248,8 +250,6 @@
/**
- * \fn int G_sock_exists (const char *name)
- *
* \brief Checks socket existence.
*
* \param[in] name
@@ -277,8 +277,6 @@
/**
- * \fn int G_sock_bind (const char *name)
- *
* \brief Binds socket to file descriptor.
*
* Takes the full pathname for a UNIX socket and returns the file
@@ -335,8 +333,6 @@
}
/**
- * \fn int G_sock_listen (int sockfd, unsigned int queue_len)
- *
* \brief Wrapper function to <i>listen()</i>.
*
* \param[in] sockfd
@@ -353,8 +349,6 @@
/**
- * \fn int G_sock_accept (int sockfd)
- *
* \brief Wrapper around <i>accept()</i>.
*
* <b>Note:</b> This call will usually block until a connection arrives.
@@ -376,8 +370,6 @@
/**
- * \fn int G_sock_connect (const char *name)
- *
* \brief Tries to connect to the UNIX socket specified by <b>name</b>.
*
* \param[in] name
@@ -412,5 +404,4 @@
return sockfd;
}
-/* vim: set softtabstop=4 shiftwidth=4 expandtab : */
#endif
Modified: grass/trunk/lib/gis/user_config.c
===================================================================
--- grass/trunk/lib/gis/user_config.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/user_config.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,7 +1,7 @@
/**
* \file user_config.c
*
- * \brief Routines related to user's GRASS configuration, tmp, and
+ * \brief GIS Library - Routines related to user's GRASS configuration, tmp, and
* miscellaneous files.
*
* Functions related to the user's GRASS configuration, tmp, and
@@ -14,6 +14,8 @@
* subdirectories. There may be more functionality desired (such as
* deletion routines, directory globs).<br>
*
+ * (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.
*
@@ -294,8 +296,6 @@
/**
- * \fn char *G_rc_path (char *element, char *item)
- *
* \brief Returns path to <b>element</b> and <b>item</b>.
*
* Either <b>element</b> or <b>item</b> can be NULL, but not both. If
Modified: grass/trunk/lib/gis/verbose.c
===================================================================
--- grass/trunk/lib/gis/verbose.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/verbose.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,19 +1,21 @@
/**
* \file verbose.c
*
- * \brief Functions to check for GRASS_VERBOSE environment variable.
+ * \brief GIS Library - Functions to check for GRASS_VERBOSE environment variable.
*
* see also:
- * G_percent()
- * G_message()
- * G_warning()
+ * - G_percent()
+ * - G_message()
+ * - G_warning()
*
+ * (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 Jachym Cepicky - jachym.cepicky at centrum cz
+ * \author Jachym Cepicky - jachym.cepicky at gmail.com
*
- * \date 2006
+ * \date 2006-2008
*/
#include <stdlib.h>
@@ -28,8 +30,6 @@
/**
- * \fn int G_verbose (void)
- *
* \brief Get current verbosity level.
*
* Currently, there are 4 levels of verbosity.
@@ -61,8 +61,6 @@
/**
- * \fn int G_verbose_max (void)
- *
* \brief Get max verbosity level.
*
* \return max verbosity level
@@ -75,8 +73,6 @@
/**
- * \fn int G_verbose_std (void)
- *
* \brief Get standard verbosity level.
*
* \return standard verbosity level
@@ -89,8 +85,6 @@
/**
- * \fn int G_verbose_min (void)
- *
* \brief Get min verbosity level.
*
* \return min verbosity level
@@ -102,8 +96,6 @@
}
/**
- * \fn int G_set_verbose (int level)
- *
* \brief Set verbosity level.
*
* \param level: new verbosity level
Modified: grass/trunk/lib/gis/view.c
===================================================================
--- grass/trunk/lib/gis/view.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/view.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file view.c
*
- * \brief 3D View functions.
+ * \brief GIS Library - 3D View functions.
*
+ * (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 Bill Brown - US Army CERL
*
- * \date 1992-2006
+ * \date 1992-2008
*/
#include <stdio.h>
@@ -32,8 +34,6 @@
/**
- * \fn int G_3dview_warning (int b)
- *
* \brief Turns 3D View warnings on and off.
*
* If Suppress_warn is 0, a warning will be printed if less than 95% of
@@ -52,8 +52,6 @@
/**
- * \fn int G_get_3dview_defaults (struct G_3dview *v, struct Cell_head *w)
- *
* \brief Sets default for <b>v</b> based on <b>w</b>.
*
* \param[in,out] v
@@ -110,8 +108,6 @@
/**
- * \fn int G_put_3dview (char *fname, char *mapset, struct G_3dview *View, struct Cell_head *Win)
- *
* \brief Saves info to a 3d.view file.
*
* The address of a window (struct Cell_head *) may be passed, or if
@@ -238,8 +234,6 @@
/**
- * \fn int G_get_3dview (char *fname, char *mapset, struct G_3dview *View)
- *
* \brief Gets a 3D View.
*
* If reading an old format, the window boundaries are not checked
Modified: grass/trunk/lib/gis/whoami.c
===================================================================
--- grass/trunk/lib/gis/whoami.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/whoami.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file whoami.c
*
- * \brief Login name functions.
+ * \brief GIS Library - Login name functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <unistd.h>
@@ -22,8 +24,6 @@
/**
- * \fn char *G_whoami(void)
- *
* \brief Gets user's name.
*
* Returns a pointer to a string containing the user's login name.
Modified: grass/trunk/lib/gis/wind_2_box.c
===================================================================
--- grass/trunk/lib/gis/wind_2_box.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/wind_2_box.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file wind_2_box.c
*
- * \brief Window box functions.
+ * \brief GIS Library - Window box functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_adjust_window_to_box (struct Cell_head *src, struct Cell_head *dst, int rows, int cols)
- *
* \brief Adjusts window to a rectangular box.
*
* Creates a new window <b>dst</b> from a window <b>src</b> which fits
Modified: grass/trunk/lib/gis/wind_format.c
===================================================================
--- grass/trunk/lib/gis/wind_format.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/wind_format.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file wind_format.c
*
- * \brief Window formatting functions.
+ * \brief GIS Library - Window formatting functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdio.h>
@@ -19,8 +21,6 @@
/**
- * \fn int G_format_northing (double north, char *buf, int projection)
- *
* \brief Northing to ASCII.
*
* Converts the double representation of the <b>north</b> coordinate to
@@ -44,8 +44,6 @@
/**
- * \fn int G_format_easting (double east, char *buf, int projection)
- *
* \brief Easting to ASCII.
*
* Converts the double representation of the <b>east</b> coordinate to
@@ -69,8 +67,6 @@
/**
- * \fn int G_format_resolution (double res, char *buf, int projection)
- *
* \brief Resolution to ASCII.
*
* Converts the double representation of the <b>resolution</b> to its
Modified: grass/trunk/lib/gis/wind_limits.c
===================================================================
--- grass/trunk/lib/gis/wind_limits.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/wind_limits.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,21 +1,23 @@
/**
* \file wind_limits.c
*
- * \brief Projection limit functions.
+ * \brief GIS Library - Projection limit functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_limit_east (double *east, int proj)
+ * \brief Function not yet implemented...
*
* If the projection has absolute limits (like lat/lon), then
* this routine modifies the input coordinate to be within the
@@ -36,7 +38,7 @@
/**
- * \fn int G_limit_west (double *west, int proj)
+ * \brief Function not yet implemented...
*
* If the projection has absolute limits (like lat/lon), then
* this routine modifies the input coordinate to be within the
@@ -57,14 +59,14 @@
/**
- * \fn int G_limit_north (double *north, int proj)
+ * \brief Limit north (y) coordinate
*
* If the projection has absolute limits (like lat/lon), then
* this routine modifies the input coordinate to be within the
* limit.<br>
*
- * \param[in] north
- * \param[in] proj
+ * \param[in,out] north north coordinate
+ * \param[in] proj projection id
* \return 1 no change
* \return 0 changed
*/
@@ -90,14 +92,14 @@
/**
- * \fn int G_limit_south (double *south, int proj)
+ * \brief Limit south (y) coordinate
*
* If the projection has absolute limits (like lat/lon), then
* this routine modifies the input coordinate to be within the
* limit.<br>
*
- * \param[in] south
- * \param[in] proj
+ * \param[in] south south coordinate
+ * \param[in] proj projection id
* \return 1 no change
* \return 0 changed
*/
Modified: grass/trunk/lib/gis/wind_overlap.c
===================================================================
--- grass/trunk/lib/gis/wind_overlap.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/wind_overlap.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file wind_overlap.c
*
- * \brief Window overlap functions.
+ * \brief GIS Library - Window overlap functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_window_overlap (struct Cell_head *window, double N, double S, double E, double W)
- *
* \brief Determins if a box overlays a map window.
*
* Given a map <b>window</b>, and a box of <b>N</b>,<b>S</b>,<b>E</b>,<b>W</b>
@@ -24,11 +24,11 @@
*
* Note: knows about global wrap-around for lat-long.
*
- * \param[in] window
- * \param[in] N
- * \param[in] S
- * \param[in] E
- * \param[in] W
+ * \param[in] window pointer to window structure
+ * \param[in] N north
+ * \param[in] S south
+ * \param[in] E east
+ * \param[in] W west
* \return 1 if box overlaps window
* \return 0 if box does not overlap window
*/
@@ -61,8 +61,6 @@
/**
- * \fn double G_window_percentage_overlap (struct Cell_head *window, double N, double S, double E, double W)
- *
* \brief Determines percentage of box is contained in the <b>window</b>.
*
* This version returns the percentage (from 0 to 1) of the box
@@ -72,12 +70,12 @@
* level-two startup so only those arcs that enter the window are
* actually read.
*
- * \param[in] window
- * \param[in] N
- * \param[in] S
- * \param[in] E
- * \param[in] W
- * \return Percentage of overlap
+ * \param[in] window pointer to widnow structure
+ * \param[in] N north
+ * \param[in] S south
+ * \param[in] E east
+ * \param[in] W west
+ * \return percentage of overlap
*/
double G_window_percentage_overlap ( const struct Cell_head *window,
Modified: grass/trunk/lib/gis/wind_scan.c
===================================================================
--- grass/trunk/lib/gis/wind_scan.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/wind_scan.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file wind_scan.c
*
- * \brief Window scanning functions.
+ * \brief GIS Library - Window scanning functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdio.h>
@@ -19,8 +21,6 @@
/**
- * \fn int G_scan_northing (char *buf, double *northing, int projection)
- *
* \brief ASCII northing to double.
*
* Converts the ASCII "northing" coordinate string in <b>buf</b> to its
@@ -50,8 +50,6 @@
/**
- * \fn int G_scan_easting (char *buf, double *easting, int projection)
- *
* \brief ASCII easting to double.
*
* Converts the ASCII "easting" coordinate string in <b>buf</b> to its
@@ -85,8 +83,6 @@
/**
- * \fn int G_scan_resolution (char *buf, double *res, int projection)
- *
* \brief ASCII resolution to double.
*
* Converts the ASCII "resolution" string in <b>buf</b> to its double
Modified: grass/trunk/lib/gis/window_map.c
===================================================================
--- grass/trunk/lib/gis/window_map.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/window_map.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file window_map.c
*
- * \brief Window mapping functions.
+ * \brief GIS Library - Window mapping functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdlib.h>
@@ -20,8 +22,6 @@
/**
- * \fn int G__create_window_mapping (int fd)
- *
* \brief Create window mapping.
*
* Creates mapping from cell header into window. The boundaries and
@@ -99,12 +99,10 @@
}
}
-#ifdef DEBUG
- fprintf (stderr, "create window mapping (%d cols)", G__.window.cols);
+ G_debug (3, "create window mapping (%d cols)", G__.window.cols);
for (i = 0; i < G__.window.cols; i++)
- fprintf (stderr, "%s%ld", i%15?" ":"\n", (long)fcb->col_map[i]);
+ G_debug(3, "%s%ld", i%15?" ":"\n", (long)fcb->col_map[i]);
fprintf (stderr, "\n");
-#endif
/* compute C1,C2 for row window mapping */
fcb->C1 = G__.window.ns_res / fcb->cellhd.ns_res ;
@@ -115,8 +113,6 @@
/**
- * \fn double G_northing_to_row (double north, const struct Cell_head *window)
- *
* \brief Northing to row.
*
* Converts a <b>north</b>ing relative to a <b>window</b> to a row.<br>
@@ -125,7 +121,7 @@
*
* \param[in] north
* \param[in] window
- * \return double
+ * \return row id
*/
double G_northing_to_row (double north,
@@ -136,8 +132,6 @@
/**
- * \fn double G_adjust_east_longitude (double east, double west)
- *
* \brief Adjust east longitude.
*
* This routine returns an equivalent <b>east</b> that is
@@ -148,7 +142,7 @@
*
* \param[in,out] east
* \param[in] west
- * \return double returns east
+ * \return east coordinate
*/
double G_adjust_east_longitude (
@@ -164,8 +158,6 @@
/**
- * \fn double G_adjust_easting (double east, const struct Cell_head *window)
- *
* \brief Returns east larger than west.
*
* If the region projection is <i>PROJECTION_LL</i>, then this routine
@@ -176,7 +168,7 @@
*
* \param[in,out] east
* \param[in] window
- * \return double returns east
+ * \return east coordinate
*/
double G_adjust_easting ( double east,
@@ -194,8 +186,6 @@
/**
- * \fn double G_easting_to_col (double east, const struct Cell_head *window)
- *
* \brief Easting to column.
*
* Converts <b>east</b> relative to a <b>window</b> to a column.<br>
@@ -204,7 +194,7 @@
*
* \param[in] east
* \param[in] window
- * \return double
+ * \return column id
*/
double G_easting_to_col ( double east,
@@ -217,22 +207,20 @@
/**
- * \fn double G_row_to_northing (double row, const struct Cell_head *window)
- *
* \brief Row to northing.
*
* Converts a <b>row</b> relative to a <b>window</b> to a
* northing.<br>
* <b>Note:</b> row is a double:
- * - row+0.0 will return the northing for the northern edge of the row.<br>
- * - row+0.5 will return the northing for the center of the row.<br>
- * - row+1.0 will return the northing for the southern edge of the row.<br>
+ * - row+0.0 will return the northing for the northern edge of the row.<br>
+ * - row+0.5 will return the northing for the center of the row.<br>
+ * - row+1.0 will return the northing for the southern edge of the row.<br>
* <b>Note:</b> The result is a <i>double</i>. Casting it to an
* <i>int</i> will give the column number.
*
* \param[in] row
* \param[in] window
- * \return double
+ * \return north coordinate
*/
double G_row_to_northing ( double row,
@@ -243,19 +231,17 @@
/**
- * \fn double G_col_to_easting (double col, const struct Cell_head *window)
- *
* \brief Column to easting.
*
* Converts a <b>col</b> relative to a <b>window</b> to an easting.<br>
* <b>Note:</b> <b>col</b> is a <i>double</i>:<br>
- * - col+0.0 will return the easting for the western edge of the column.<br>
- * - col+0.5 will return the easting for the center of the column.<br>
- * - col+1.0 will return the easting for the eastern edge of the column.<br>
+ * - col+0.0 will return the easting for the western edge of the column.<br>
+ * - col+0.5 will return the easting for the center of the column.<br>
+ * - col+1.0 will return the easting for the eastern edge of the column.<br>
*
* \param[in] col
* \param[in] window
- * \return double
+ * \return east coordinate
*/
double G_col_to_easting (double col,
@@ -266,8 +252,6 @@
/**
- * \fn int G_window_rows ()
- *
* \brief Number of rows in active window.
*
* This routine returns the number of rows in the active module window.
@@ -288,7 +272,7 @@
}
\endcode
*
- * \return int number of rows
+ * \return number of rows
*/
int G_window_rows (void)
@@ -300,8 +284,6 @@
/**
- * \fn int G_window_cols ()
- *
* \brief Number of columns in active window.
*
* These
@@ -323,7 +305,7 @@
}
\endcode
*
- * \return int number of columns
+ * \return number of columns
*/
int G_window_cols (void)
@@ -335,8 +317,6 @@
/**
- * \fn int G__init_window ()
- *
* \brief Initialize window.
*
* \return always returns 0
@@ -355,8 +335,6 @@
/**
- * \fn int G_row_repeat_nomask (int fd, int row)
- *
* \brief Loops rows until mismatch?.
*
* This routine works fine if the mask is not set. It may give incorrect
Modified: grass/trunk/lib/gis/wr_cellhd.c
===================================================================
--- grass/trunk/lib/gis/wr_cellhd.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/wr_cellhd.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file wr_cellhd.c
*
- * \brief Write Cell Header functions.
+ * \brief GIS Library - Write Cell Header functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdio.h>
@@ -16,12 +18,10 @@
/**
- * \fn int G__write_Cell_head (FILE *fd, struct Cell_head *cellhd, int is_cellhd)
- *
* \brief Write cell header or window.
*
- * \param[in,out] fd
- * \param[in] cellhd
+ * \param[in,out] fd header file
+ * \param[in] cellhd pointed to cell header structure
* \param[in] is_cellhd 1 cell header; 0 window
* \return always returns 1
*/
@@ -69,12 +69,10 @@
/**
- * \fn int G__write_Cell_head3 (FILE *fd, struct Cell_head *cellhd, int is_cellhd)
- *
* \brief Write 3D cell header or window.
*
- * \param[in,out] fd
- * \param[in] cellhd
+ * \param[in,out] fd header file
+ * \param[in] cellhd pointer to cell header structure
* \param[in] is_cellhd 1 cell header; 0 window
* \return always returns 1
*/
Modified: grass/trunk/lib/gis/writ_zeros.c
===================================================================
--- grass/trunk/lib/gis/writ_zeros.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/writ_zeros.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file writ_zeros.c
*
- * \brief Write zero functions.
+ * \brief GIS Library - Write zero functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <unistd.h>
@@ -16,8 +18,6 @@
/**
- * \fn int G_write_zeros (int fd, size_t n)
- *
* \brief Writes <b>n</b> bytes of 9 to file descriptor <b>fd</b>
*
* \param[in] fd file descriptor
Modified: grass/trunk/lib/gis/yes.c
===================================================================
--- grass/trunk/lib/gis/yes.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/yes.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file yes.c
*
- * \brief Yes/No functions.
+ * \brief GIS Library - Yes/No functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <stdio.h>
@@ -16,8 +18,6 @@
/**
- * \fn int G_yes (char *question, int dflt)
- *
* \brief Ask a yes/no question.
*
* This routine prints a <b>question</b> to the user, and expects the user to
Modified: grass/trunk/lib/gis/zero.c
===================================================================
--- grass/trunk/lib/gis/zero.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/zero.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,14 +1,16 @@
/**
* \file zero.c
*
- * \brief Zeroing functions.
+ * \brief GIS Library - Zeroing functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <string.h>
@@ -16,8 +18,6 @@
/**
- * \fn int G_zero (void *buf, int i)
- *
* \brief Zero out a buffer, <b>buf</b>, of length <b>i</b>.
*
* \param[in,out] buf
Modified: grass/trunk/lib/gis/zero_cell.c
===================================================================
--- grass/trunk/lib/gis/zero_cell.c 2008-07-31 18:52:52 UTC (rev 32417)
+++ grass/trunk/lib/gis/zero_cell.c 2008-07-31 19:21:30 UTC (rev 32418)
@@ -1,22 +1,22 @@
/**
* \file zero_cell.c
*
- * \brief Zero cell buffer functions.
+ * \brief GIS Library - Zero cell buffer functions.
*
+ * (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 1999-2006
+ * \date 1999-2008
*/
#include <grass/gis.h>
/**
- * \fn int G_zero_cell_buf (CELL *buf)
- *
* \brief Zero a raster CELL buffer.
*
* This routines assigns each member of the raster buffer array
@@ -39,8 +39,6 @@
/**
- * \fn int G_zero_raster_buf (void *rast, RASTER_MAP_TYPE data_type)
- *
* \brief Zero a raster buffer.
*
* This routines assigns each member of the raster buffer array
More information about the grass-commit
mailing list