[GRASS-SVN] r56087 - grass/trunk/include/vect

[svn_grass at osgeo.org]

Author: martinl
Date: 2013-05-02 13:36:26 -0700 (Thu, 02 May 2013)
New Revision: 56087

Modified:
   grass/trunk/include/vect/dig_structs.h
Log:
vlib: doxygen cosmetics (improve constraint struct)


Modified: grass/trunk/include/vect/dig_structs.h
===================================================================
--- grass/trunk/include/vect/dig_structs.h	2013-05-02 19:33:24 UTC (rev 56086)
+++ grass/trunk/include/vect/dig_structs.h	2013-05-02 20:36:26 UTC (rev 56087)
@@ -1343,25 +1343,32 @@
     /* constraints for reading in lines  (not polys yet) */
 
     /*!
-      \brief Constraints (region, type, field)
-
-      Note: Non-zero flag to enable given constraint.
+      \brief Constraints for sequential feature access
     */
     struct {
 	/*!
-	  \brief Region constraint
+	  \brief Non-zero value to enable region constraint
 	*/
 	int region_flag;
+        /*!
+          \brief Region (bbox) constraint
+        */
 	struct bound_box box;
 	/*!
-	  \brief Type constraint
+	  \brief Non-zero value to enable feature type constraint
 	*/
 	int type_flag;
+        /*!
+          \brief Feature type constraint
+        */
 	int type;
 	/*!
-	  \brief Field constraint
+	  \brief Non-zero value to enable field constraint
 	*/
 	int field_flag;
+        /*!
+          \brief Field number constraint (see line_cats structure)
+        */
 	int field;
     } constraint;