[GRASS-SVN] r46674 -
grass/branches/releasebranch_6_4/lib/vector/vedit
svn_grass at osgeo.org
svn_grass at osgeo.org
Mon Jun 13 07:48:50 EDT 2011
Author: mmetz
Date: 2011-06-13 04:48:49 -0700 (Mon, 13 Jun 2011)
New Revision: 46674
Modified:
grass/branches/releasebranch_6_4/lib/vector/vedit/break.c
grass/branches/releasebranch_6_4/lib/vector/vedit/cats.c
grass/branches/releasebranch_6_4/lib/vector/vedit/chtype.c
grass/branches/releasebranch_6_4/lib/vector/vedit/copy.c
grass/branches/releasebranch_6_4/lib/vector/vedit/delete.c
grass/branches/releasebranch_6_4/lib/vector/vedit/distance.c
grass/branches/releasebranch_6_4/lib/vector/vedit/flip.c
grass/branches/releasebranch_6_4/lib/vector/vedit/merge.c
grass/branches/releasebranch_6_4/lib/vector/vedit/move.c
grass/branches/releasebranch_6_4/lib/vector/vedit/select.c
grass/branches/releasebranch_6_4/lib/vector/vedit/snap.c
grass/branches/releasebranch_6_4/lib/vector/vedit/veditlib.dox
grass/branches/releasebranch_6_4/lib/vector/vedit/vertex.c
grass/branches/releasebranch_6_4/lib/vector/vedit/zbulk.c
Log:
doxygenize (backport from devbr)
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/break.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/break.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/break.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,16 +1,14 @@
-/**
- \file vector/vedit/break.c
+/*!
+ \file lib/vector/vedit/break.c
- \brief Vedit library - split, break, connect lines
-
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+ \brief Vedit library - split, break, connect lines
+
+ (C) 2007-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 Martin Landa <landa.martin gmail.com>
*/
#include <math.h>
@@ -19,17 +17,17 @@
static int connect_lines(struct Map_info *, int, int, int,
double, struct ilist *);
-/**
- \brief Split selected lines on given position
-
- \param Map vector map
- \param List list of selected lines
- \param coord points location
- \param[out] List_updated list of rewritten features (or NULL)
-
- \return number of modified lines
- \return -1 on error
- */
+/*!
+ \brief Split selected lines on given position
+
+ \param Map pointer to Map_info
+ \param List list of selected lines
+ \param coord points location
+ \param[out] List_updated list of rewritten features (or NULL)
+
+ \return number of modified lines
+ \return -1 on error
+*/
int Vedit_split_lines(struct Map_info *Map, struct ilist *List,
struct line_pnts *coord, double thresh,
struct ilist *List_updated)
@@ -130,20 +128,20 @@
return nlines_modified;
}
-/**
- \brief Connect lines in given threshold
-
- <pre>
- \ \
+/*!
+ \brief Connect lines in given threshold
+
+ \code
+ \ \
id1 \ -> \
\
id2 --------- -----+---
- </pre>
+ \endcode
If two lines are selected and <i>thresh</i> is -1, no limit is
applied.
- \param Map vector map
+ \param Map pointer to Map_info
\param List list of selected lines
\param thresh threshold value
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/cats.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/cats.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/cats.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,34 +1,31 @@
+/*!
+ \file lib/vector/vedit/cats.c
-/**
- \file vector/vedit/cats.c
+ \brief Vedit library - category manipulation
+
+ (C) 2006-2008 by the GRASS Development Team
- \brief Vedit library - category manipulation
-
- (C) 2006-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 gmail.com>
- \author Martin Landa <landa.martin gmail.com>
-
- \date 2006-2008
+ 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 gmail.com>
+ \author Martin Landa <landa.martin gmail.com>
*/
#include <grass/glocale.h>
#include <grass/vedit.h>
-/**
- \brief Add / remove categories
-
- \param Map vector map
- \param List list of selected primitives
- \param layer layer number
- \param del action (non-zero for delete otherwise add)
- \param cats_list list of category numbers
-
- \return number of modified primitives
- \return -1 on error
+/*!
+ \brief Add / remove categories
+
+ \param Map pointer to Map_info
+ \param List list of selected primitives
+ \param layer layer number
+ \param del action (non-zero for delete otherwise add)
+ \param cats_list list of category numbers
+
+ \return number of modified primitives
+ \return -1 on error
*/
int Vedit_modify_cats(struct Map_info *Map, struct ilist *List,
int layer, int del, struct cat_list *Clist)
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/chtype.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/chtype.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/chtype.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,33 +1,30 @@
-
-/**
- \file vector/vedit/chtype.c
-
- \brief Vedit library - change primitives type
-
- (C) 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 Martin Landa <landa.martin gmail.com>
-
- \date 2008
+/*!
+ \file vector/vedit/chtype.c
+
+ \brief Vedit library - change primitives type
+
+ (C) 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 Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Change primitive type
+/*!
+ \brief Change primitive type
+
+ Supported conversions:
+ - point <-> centroid
+ - line <-> boundary
- Supported conversions:
- - point <-> centroid
- - line <-> boundary
-
- \param Map vector map
- \param List list of selected primitives
-
- \return number of modified primitives
- \return -1 on error
+ \param Map pointer to Map_info
+ \param List list of selected primitives
+
+ \return number of modified primitives
+ \return -1 on error
*/
int Vedit_chtype_lines(struct Map_info *Map, struct ilist *List)
{
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/copy.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/copy.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/copy.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,32 +1,29 @@
+/*!
+ \file lib/vector/vedit/copy.c
-/**
- \file vector/vedit/copy.c
-
- \brief Vedit library - copy primitives
-
- (C) 2007-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 gmail.com>
- \author Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+ \brief Vedit library - copy primitives
+
+ (C) 2007-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 gmail.com>
+ \author Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Copy selected primitives
-
- \param Map vector map copy to
- \param FromMap vector map copy from (if not given use Map)
- \param List list of selected primitives (to be copied)
-
- \return number of copied primitives
- \return -1 on error
- */
+/*!
+ \brief Copy selected primitives
+
+ \param Map pointer to Map_info copy to
+ \param FromMap vector map copy from (if not given use Map)
+ \param List list of selected primitives (to be copied)
+
+ \return number of copied primitives
+ \return -1 on error
+*/
int Vedit_copy_lines(struct Map_info *Map, struct Map_info *FromMap,
struct ilist *List)
{
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/delete.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/delete.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/delete.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,30 +1,27 @@
+/*!
+ \file lib/vector/vedit/delete.c
-/**
- \file vector/vedit/delete.c
+ \brief Vedit library - delete primitives
- \brief Vedit library - delete primitives
+ (C) 2007-2008 by the GRASS Development Team
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+ This program is free software under the GNU General Public License
+ (>=v2). Read the file COPYING that comes with GRASS for details.
+
+ \author Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Delete selected primitives
-
- \param Map vector map
- \param List list of primitives to be deleted
-
- \return number of deleted primitives
- \return -1 on on error
- */
+/*!
+ \brief Delete selected primitives
+
+ \param Map pointer to Map_info
+ \param List list of primitives to be deleted
+
+ \return number of deleted primitives
+ \return -1 on on error
+*/
int Vedit_delete_lines(struct Map_info *Map, struct ilist *List)
{
int i, line;
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/distance.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/distance.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/distance.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,31 +1,28 @@
+/*!
+ \file lib/vector/vedit/distance.c
-/**
- \file vector/vedit/distance.c
+ \brief Vedit library - distance calculation
+
+ (C) 2007-2008 by the GRASS Development Team
- \brief Vedit library - distance calculation
-
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+ This program is free software under the GNU General Public License
+ (>=v2). Read the file COPYING that comes with GRASS for details.
+
+ \author Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Calculate distances between two lines
-
- \todo LL projection
-
- \param Points1 first line geometry
- \param Points2 second line geometry
- \param[out] index of minimal distance
-
- \return minimal distance betwen two lines (their nodes)
+/*!
+ \brief Calculate distances between two lines
+
+ \todo LL projection
+
+ \param Points1 first line geometry
+ \param Points2 second line geometry
+ \param[out] index of minimal distance
+
+ \return minimal distance betwen two lines (their nodes)
*/
double Vedit_get_min_distance(struct line_pnts *Points1,
struct line_pnts *Points2, int with_z,
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/flip.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/flip.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/flip.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,30 +1,27 @@
-
-/**
- \file vector/vedit/flip.c
-
- \brief Vedit library - flip lines
-
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+/*!
+ \file lib/vector/vedit/flip.c
+
+ \brief Vedit library - flip lines
+
+ (C) 2007-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 Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Flip direction of selected lines
-
- \param Map vector map
- \param List list of selected lines
-
- \return number of modified lines
- \return -1 on error
- */
+/*!
+ \brief Flip direction of selected lines
+
+ \param Map pointer to Map_info
+ \param List list of selected lines
+
+ \return number of modified lines
+ \return -1 on error
+*/
int Vedit_flip_lines(struct Map_info *Map, struct ilist *List)
{
struct line_cats *Cats;
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/merge.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/merge.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/merge.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,49 +1,46 @@
-
-/**
- \file vector/vedit/merge.c
-
- \brief Vedit library - merge lines
-
- (C) 2006-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 gmail.com>
- \author Martin Landa <landa.martin gmail.com>
-
- \date 2006-2008
+/*!
+ \file lib/vector/vedit/merge.c
+
+ \brief Vedit library - merge lines
+
+ (C) 2006-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 gmail.com>
+ \author Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Merge two given lines a, b
+/*!
+ \brief Merge two given lines a, b
+
+ a : Points1/Cats1
+ b : Points2/Cats2
+ merged line : Points/Cats
- a : Points1/Cats1
- b : Points2/Cats2
- merged line : Points/Cats
-
- \param Points1,Cats1 first line
- \param Points2,Cats2 second line
- \param thresh threshold value
- \param[out] Points result line
-
- \return 1 on success
- \return 0 on error
+ \param Points1,Cats1 first line
+ \param Points2,Cats2 second line
+ \param thresh threshold value
+ \param[out] Points result line
+
+ \return 1 on success
+ \return 0 on error
*/
static int merge_lines(struct line_pnts *Points1, struct line_cats *Cats1,
struct line_pnts *Points2, struct line_cats *Cats2,
double thresh, struct line_pnts **Points);
-/**
- \brief Merge lines/boundaries
-
- At least two lines need to be given.
-
- \param Map vector map
- \param List list of selected lines
-
+/*!
+ \brief Merge lines/boundaries
+
+ At least two lines need to be given.
+
+ \param Map pointer to Map_info
+ \param List list of selected lines
+
\return number of merged lines
\return -1 on error
*/
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/move.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/move.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/move.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,33 +1,30 @@
-
-/**
- \file vector/vedit/move.c
-
- \brief Vedit library - move primitives
-
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
- \author Jachym Cepicky <jachym.cepicky gmail.com>
-
- \date 2007-2008
+/*!
+ \file lib/vector/vedit/move.c
+
+ \brief Vedit library - move primitives
+
+ (C) 2007-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 Martin Landa <landa.martin gmail.com>
+ \author Jachym Cepicky <jachym.cepicky gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Move selected primitives
-
- \param Map vector map
- \param BgMap, nbgmaps list of background vector maps used for snapping
- \param List list of primitives to be moved
- \param move_x,move_y,move_z direction (move_z used only if map is 3D)
- \param snap enable snapping (see globals.h)
-
- \return number of modified primitives
- \return -1 on error
+/*!
+ \brief Move selected primitives
+
+ \param Map pointer to Map_info
+ \param BgMap, nbgmaps list of background vector maps used for snapping
+ \param List list of primitives to be moved
+ \param move_x,move_y,move_z direction (move_z used only if map is 3D)
+ \param snap enable snapping (see globals.h)
+
+ \return number of modified primitives
+ \return -1 on error
*/
int Vedit_move_lines(struct Map_info *Map, struct Map_info **BgMap,
int nbgmaps, struct ilist *List, double move_x,
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/select.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/select.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/select.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,17 +1,14 @@
+/*!
+ \file lib/vector/vedit/select.c
-/**
- \file vector/vedit/select.c
-
- \brief Vedit library - select primitives by query
-
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+ \brief Vedit library - select primitives by query
+
+ (C) 2007-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 Martin Landa <landa.martin gmail.com>
*/
#include <grass/glocale.h>
@@ -22,24 +19,24 @@
static int merge_lists(struct ilist *alist, struct ilist *blist);
-/**
- \brief Select primitives by query (based on geometry properties)
+/*!
+ \brief Select primitives by query (based on geometry properties)
+
+ Currently supported:
+ - QUERY_LENGTH, select all lines longer than threshold (or shorter if threshold is < 0)
+ - QUERY_DANGLE, select all dangles longer than threshold (or shorter if threshold is < 0)
- Currently supported:
- - QUERY_LENGTH, select all lines longer than threshold (or shorter if threshold is < 0)
- - QUERY_DANGLE, select all dangles longer than threshold (or shorter if threshold is < 0)
+ Perform global query if <i>List</i> is empty otherwise query only
+ selected vector objects.
- Perform global query if <i>List</i> is empty otherwise query only
- selected vector objects.
-
- \param Map vector map
- \param type feature type
- \param layer layer number
- \param thresh threshold value (< 0 for 'shorter', > 0 for 'longer')
- \param query query (length, dangle, ...)
- \param[in,out] List list of selected features
-
- \return number of selected primitives
+ \param Map pointer to Map_info
+ \param type feature type
+ \param layer layer number
+ \param thresh threshold value (< 0 for 'shorter', > 0 for 'longer')
+ \param query query (length, dangle, ...)
+ \param[in,out] List list of selected features
+
+ \return number of selected primitives
*/
int Vedit_select_by_query(struct Map_info *Map,
int type, int layer, double thresh, int query,
@@ -125,7 +122,7 @@
return List->n_values;
}
-/**
+/*!
\brief Query selected primitive
\return 1 line test positive
@@ -236,7 +233,7 @@
return 0;
}
-/**
+/*!
\brief Merge two lists, i.e. store only duplicate items
\param[in,out] alist list to be merged
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/snap.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/snap.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/snap.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,32 +1,29 @@
+/*!
+ \file lib/vector/vedit/snap.c
-/**
- \file vector/vedit/snap.c
-
- \brief Vedit library - snapping
-
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+ \brief Vedit library - snapping
+
+ (C) 2007-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 Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Snap given point to the nearest primitive
-
- \param Map vector map
- \param line line to be excluded (point on line)
- \param x,y,z point on line to be snapped
- \param thresh snapping threshold (>0)
- \param vertex snap also to vertex (non-zero)
-
- \return 1 snapped
- \return 0 not snapped
+/*!
+ \brief Snap given point to the nearest primitive
+
+ \param Map pointer to Map_info
+ \param line line to be excluded (point on line)
+ \param x,y,z point on line to be snapped
+ \param thresh snapping threshold (>0)
+ \param vertex snap also to vertex (non-zero)
+
+ \return 1 snapped
+ \return 0 not snapped
*/
int Vedit_snap_point(struct Map_info *Map,
int line, double *x, double *y, double *z, double thresh,
@@ -84,20 +81,20 @@
return snapped;
}
-/**
- \brief Snap selected primitive to its nearest primitive
-
- \param Map vector map
- \param BgMap,nbgmaps list of background maps used for snapping
- \param line line id to be snapped (if already written, otherwise -1)
- \param Points line geometry
- \param layer layer number
- \param thresh threshold value used for snapping (>0)
- \param to_vertex allow snapping also to vertex
-
- \return 1 line snapped
- \return 0 line not snapped
- \return -1 line is dead (if 'line' is > 0)
+/*!
+ \brief Snap selected primitive to its nearest primitive
+
+ \param Map pointer to Map_info
+ \param BgMap,nbgmaps list of background maps used for snapping
+ \param line line id to be snapped (if already written, otherwise -1)
+ \param Points line geometry
+ \param layer layer number
+ \param thresh threshold value used for snapping (>0)
+ \param to_vertex allow snapping also to vertex
+
+ \return 1 line snapped
+ \return 0 line not snapped
+ \return -1 line is dead (if 'line' is > 0)
*/
int Vedit_snap_line(struct Map_info *Map, struct Map_info **BgMap,
int nbgmaps, int line, struct line_pnts *Points,
@@ -162,18 +159,18 @@
return rewrite;
}
-/**
- \brief Snap lines/boundaries
-
- \param Map vector map
- \param BgMap,nbgmaps list of background maps used for snapping
- \param List list of lines to be snapped
- \param layer layer number
- \param thresh threshold value used for snapping (>0)
- \param to_vertex allow snapping also to vertex
-
- \return number of snapped lines
- \return -1 on error
+/*!
+ \brief Snap lines/boundaries
+
+ \param Map pointer to Map_info
+ \param BgMap,nbgmaps list of background maps used for snapping
+ \param List list of lines to be snapped
+ \param layer layer number
+ \param thresh threshold value used for snapping (>0)
+ \param to_vertex allow snapping also to vertex
+
+ \return number of snapped lines
+ \return -1 on error
*/
int Vedit_snap_lines(struct Map_info *Map, struct Map_info **BgMap,
int nbgmaps, struct ilist *List, double thresh,
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/veditlib.dox
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/veditlib.dox 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/veditlib.dox 2011-06-13 11:48:49 UTC (rev 46674)
@@ -65,15 +65,16 @@
- Vedit_bulk_labeling()
-\section contacts Contacts
+ - Vedit_render_map()
- Martin Landa <landa.martin gmail.com>
-
\section seealso See Also
- \ref Vector_Library
- \ref dbmilib
-Last change: $Date$
+\section authors Authors
+
+ Martin Landa <landa.martin gmail.com>
+
*/
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/vertex.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/vertex.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/vertex.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,38 +1,35 @@
-
-/**
- \file vector/vedit/vertex.c
-
- \brief Vedit library - vertex manipulation
-
- (C) 2006-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 gmail.com>
- \author Martin Landa <landa.martin gmail.com>
-
- \date 2006-2008
+/*!
+ \file lib/vector/vedit/vertex.c
+
+ \brief Vedit library - vertex manipulation
+
+ (C) 2006-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 gmail.com>
+ \author Martin Landa <landa.martin gmail.com>
*/
#include <grass/vedit.h>
-/**
- \brief Move all vertices in bounding box(es)
-
- \param Map vector map
- \param BgMap, nbgmaps list of background vector maps for snapping
- \param List list of selected lines
- \param coord points location
- \param thresh_coords threshold value for selecting lines
- \param thresh_snap threshold value used for snapping
- \param move_x,move_y,move_z direction (move_z is used when map is 3D)
- \param move_first move only first vertex found in the bounding box
- \param snap snapping mode (see vedit.h)
-
- \return number of moved verteces
- \return -1 on error
- */
+/*!
+ \brief Move all vertices in bounding box(es)
+
+ \param Map pointer to Map_info
+ \param BgMap, nbgmaps list of background vector maps for snapping
+ \param List list of selected lines
+ \param coord points location
+ \param thresh_coords threshold value for selecting lines
+ \param thresh_snap threshold value used for snapping
+ \param move_x,move_y,move_z direction (move_z is used when map is 3D)
+ \param move_first move only first vertex found in the bounding box
+ \param snap snapping mode (see vedit.h)
+
+ \return number of moved verteces
+ \return -1 on error
+*/
int Vedit_move_vertex(struct Map_info *Map, struct Map_info **BgMap,
int nbgmaps, struct ilist *List,
struct line_pnts *coord, double thresh_coords,
@@ -179,20 +176,20 @@
return nvertices_moved;
}
-/**
- \brief Add new vertex to line
-
- Shape of line is not changed.
-
- \todo 3D
-
- \param Map vector map
- \param List list of lines
- \param coord points location
- \param thresh find line in given threshold
-
- \return number of add verteces
- \return -1 on error
+/*!
+ \brief Add new vertex to line
+
+ Shape of line is not changed.
+
+ \todo 3D
+
+ \param Map pointer to Map_info
+ \param List list of lines
+ \param coord points location
+ \param thresh find line in given threshold
+
+ \return number of add verteces
+ \return -1 on error
*/
int Vedit_add_vertex(struct Map_info *Map, struct ilist *List,
struct line_pnts *coord, double thresh)
@@ -269,18 +266,18 @@
return nvertices_added;
}
-/**
- \brief Remove vertex from line
-
- \todo 3D
-
- \param Map vector map
- \param List list of selected lines
- \param coord points location
- \param thresh threshold value to find a line
-
- \return number of removed vertices
- \return -1 on error
+/*!
+ \brief Remove vertex from line
+
+ \todo 3D
+
+ \param Map pointer to Map_info
+ \param List list of selected lines
+ \param coord points location
+ \param thresh threshold value to find a line
+
+ \return number of removed vertices
+ \return -1 on error
*/
int Vedit_remove_vertex(struct Map_info *Map, struct ilist *List,
struct line_pnts *coord, double thresh)
Modified: grass/branches/releasebranch_6_4/lib/vector/vedit/zbulk.c
===================================================================
--- grass/branches/releasebranch_6_4/lib/vector/vedit/zbulk.c 2011-06-13 11:41:57 UTC (rev 46673)
+++ grass/branches/releasebranch_6_4/lib/vector/vedit/zbulk.c 2011-06-13 11:48:49 UTC (rev 46674)
@@ -1,36 +1,33 @@
+/*!
+ \file lib/vector/vedit/zbulk.c
-/**
- \file vector/vedit/zbulk.c
-
- \brief Vedit library - Bulk labeling (automated labeling of vector
- features)
-
- (C) 2007-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 Martin Landa <landa.martin gmail.com>
-
- \date 2007-2008
+ \brief Vedit library - Bulk labeling (automated labeling of vector
+ features)
+
+ (C) 2007-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 Martin Landa <landa.martin gmail.com>
*/
#include <grass/dbmi.h>
#include <grass/vedit.h>
-/**
- \brief Lines z-bulk labeling
-
- Automated labeling (z coordinate assignment) of vector lines (iso-lines).
-
- \param Map vector map
- \param List list of selected lines
- \param point_start_end staring and ending point
- \param start starting value
- \param step step value
-
- \return number of modified features
- \return -1 on error
+/*!
+ \brief Lines z-bulk labeling
+
+ Automated labeling (z coordinate assignment) of vector lines (iso-lines).
+
+ \param Map pointer to Map_info
+ \param List list of selected lines
+ \param point_start_end staring and ending point
+ \param start starting value
+ \param step step value
+
+ \return number of modified features
+ \return -1 on error
*/
int Vedit_bulk_labeling(struct Map_info *Map, struct ilist *List,
double x1, double y1, double x2, double y2,
More information about the grass-commit
mailing list