[GRASS-SVN] r52606 - in grass/trunk/lib: gis segment

svn_grass at osgeo.org svn_grass at osgeo.org
Thu Aug 9 02:16:13 PDT 2012


Author: wenzeslaus
Date: 2012-08-09 02:16:13 -0700 (Thu, 09 Aug 2012)
New Revision: 52606

Modified:
   grass/trunk/lib/gis/distance.c
   grass/trunk/lib/segment/address.c
   grass/trunk/lib/segment/close.c
   grass/trunk/lib/segment/flush.c
   grass/trunk/lib/segment/format.c
   grass/trunk/lib/segment/get.c
   grass/trunk/lib/segment/init.c
   grass/trunk/lib/segment/open.c
   grass/trunk/lib/segment/pagein.c
   grass/trunk/lib/segment/pageout.c
   grass/trunk/lib/segment/put_row.c
   grass/trunk/lib/segment/release.c
   grass/trunk/lib/segment/seek.c
Log:
dox: segment library (unnecessary fn and SEG/seg mess)

Modified: grass/trunk/lib/gis/distance.c
===================================================================
--- grass/trunk/lib/gis/distance.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/gis/distance.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -83,8 +83,8 @@
 /*!
   \brief Returns distance between two line segments in meters.
   
-  \param ax1,ay2,ax2,ay2 first segment
-  \param bx1,by2,bx2,by2 second segment
+  \param ax1,ay1,ax2,ay2 first segment
+  \param bx1,by1,bx2,by2 second segment
   
   \return distance value
 */
@@ -112,7 +112,7 @@
   \brief Returns distance between a point and line segment in meters.
   
   \param xp,yp point coordinates
-  \param x1,x1 segment point coordinates
+  \param x1,y1 segment point coordinates
   \param x2,y2 segment point coordinates
   
   \return distance

Modified: grass/trunk/lib/segment/address.c
===================================================================
--- grass/trunk/lib/segment/address.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/address.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -92,8 +92,6 @@
 }
 
 /**
- * \fn int segment_address (SEGMENT *SEG, int row, int col, int *n, int *index)
- *
  * \brief Gets segment address and returns <b>n</b> and <b>index</b>.
  *
  * \param[in] SEG segment

Modified: grass/trunk/lib/segment/close.c
===================================================================
--- grass/trunk/lib/segment/close.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/close.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -25,7 +25,7 @@
  * Releases the allocated memory associated with the segment file 
  * <b>seg</b> and deletes the temporary file.
  *
- * \param[in,out] seg
+ * \param[in,out] SEG segment
  * \return 1 if successful
  * \return -1 if SEGMENT is not available (not open)
  */

Modified: grass/trunk/lib/segment/flush.c
===================================================================
--- grass/trunk/lib/segment/flush.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/flush.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -25,7 +25,7 @@
  * final <i>segment_put()</i> to force all pending updates to disk. Must 
  * also be called before the first call to <i>segment_get_row</i>.
  *
- * \param[in] seg segment
+ * \param[in] SEG segment
  * \return always returns 0
  */
 

Modified: grass/trunk/lib/segment/format.c
===================================================================
--- grass/trunk/lib/segment/format.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/format.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -31,8 +31,6 @@
 
 
 /**
- * \fn int segment_format (int fd, int nrows, int ncols, int srows, int scols, int len)
- *
  * \brief Format a segment file.
  *
  * The segmentation routines require a disk file to be used for paging 
@@ -68,8 +66,6 @@
 }
 
 /**
- * \fn int segment_format_nofill (int fd, int nrows, int ncols, int srows, int scols, int len)
- *
  * \brief Format a segment file.
  *
  * The segmentation routines require a disk file to be used for paging 

Modified: grass/trunk/lib/segment/get.c
===================================================================
--- grass/trunk/lib/segment/get.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/get.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -21,8 +21,6 @@
 
 
 /**
- * \fn int segment_get (SEGMENT *SEG, void *buf, int row, int col)
- *
  * \brief Get value from segment file.
  *
  * Provides random read access to the segmented data. It gets
@@ -30,7 +28,7 @@
  * <b>seg</b> for the corresponding <b>row</b> and <b>col</b> in the
  * original data matrix.
  *
- * \param[in] seg segment
+ * \param[in] SEG segment
  * \param[in,out] buf value return buffer
  * \param[in] row
  * \param[in] col

Modified: grass/trunk/lib/segment/init.c
===================================================================
--- grass/trunk/lib/segment/init.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/init.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -48,7 +48,7 @@
  * <b>Note:</b> The size of a segment is <em>scols*srows*len</em> plus a 
  * few bytes for managing each segment.
  *
- * \param[in,out] seg segment
+ * \param[in,out] SEG segment
  * \param[in] fd file descriptor
  * \param[in] nseg number of segments to remain in memory
  * \return 1 if successful

Modified: grass/trunk/lib/segment/open.c
===================================================================
--- grass/trunk/lib/segment/open.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/open.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -19,8 +19,6 @@
 #include "local_proto.h"
 
 /**
- * \fn int segment_open (SEGMENT *SEG, char *fname, off_t nrows, off_t ncols, int srows, int scols, int len, int nseg)
- *
  * \brief Initialize segment structure and open segment file.
  *
  * Initializes the <b>seg</b> structure and prepares a temporary file. 
@@ -28,7 +26,7 @@
  *
  * <b>Note:</b> The file with name fname will be created anew.
  *
- * \param[in,out] seg segment
+ * \param[in,out] SEG segment
  * \param[in] fname file name
  * \param[in] nrows number of non-segmented rows
  * \param[in] ncols number of non-segmented columns

Modified: grass/trunk/lib/segment/pagein.c
===================================================================
--- grass/trunk/lib/segment/pagein.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/pagein.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -28,7 +28,7 @@
  * Finds <b>n</b> in the segment file, <b>seg</b>, and selects it as the 
  * current segment.
  *
- * \param[in] seg segment
+ * \param[in] SEG segment
  * \param[in] n segment number
  * \return 1 if successful
  * \return -1 if unable to seek or read segment file

Modified: grass/trunk/lib/segment/pageout.c
===================================================================
--- grass/trunk/lib/segment/pageout.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/pageout.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -28,7 +28,7 @@
  * Finds segment value <b>i</b> in segment <b>seg</b> and pages it out 
  * to disk.
  *
- * \param[in] seg segment
+ * \param[in] SEG segment
  * \param[in] i segment value
  * \return 1 if successful
  * \return -1 on error

Modified: grass/trunk/lib/segment/put_row.c
===================================================================
--- grass/trunk/lib/segment/put_row.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/put_row.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -25,8 +25,6 @@
 
 
 /**
- * \fn int segment_put_row (SEGMENT *SEG, void *buf, int row)
- *
  * \brief Write row to segment file.
  *
  * Transfers non-segmented matrix data, row by row, into a segment
@@ -36,7 +34,7 @@
  * file. <b>row</b> specifies the row from the data matrix being 
  * transferred.
  *
- * \param[in,out] seg segment
+ * \param[in,out] SEG segment
  * \param[in] buf data to write to segment
  * \param[in] row
  * \return 1 if successful

Modified: grass/trunk/lib/segment/release.c
===================================================================
--- grass/trunk/lib/segment/release.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/release.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -28,7 +28,7 @@
  * <b>Note:</b> Does not close the file. Does not flush the data which 
  * may be pending from previous <i>segment_put()</i> calls.
  *
- * \param[in,out] seg
+ * \param[in,out] SEG segment
  * \return 1 if successful
  * \return -1 if SEGMENT is not available (not open)
  */

Modified: grass/trunk/lib/segment/seek.c
===================================================================
--- grass/trunk/lib/segment/seek.c	2012-08-09 08:39:14 UTC (rev 52605)
+++ grass/trunk/lib/segment/seek.c	2012-08-09 09:16:13 UTC (rev 52606)
@@ -22,8 +22,6 @@
 
 
 /**
- * \fn int segment_seek (SEGMENT *SEG, int n, int index)
- *
  * \brief Seek into a segment.
  *
  * \param[in,out] SEG segment



More information about the grass-commit mailing list