pointset: doxygen comments

diff --git a/lib/common/pointset.c b/lib/common/pointset.c
index 09f1862ad361714d2daf65fc1aee5bb8b18551ad..f681c35814cfad7a108f82bb0a0e067611c7b302 100644 (file)
--- a/lib/common/pointset.c
+++ b/lib/common/pointset.c
@@ -205,14 +205,14 @@ void freePM(PointMap * ps)
     free(dp);
 }
 
-int insertPM(PointMap * pm, int x, int y, int v)
+int insertPM(PointMap * pm, int x, int y, int value)
 {
     mpair *p;
     mpair dummy;
 
     dummy.id.x = x;
     dummy.id.y = y;
-    dummy.v = v;
+    dummy.v = value;
     p = dtinsert(pm, &dummy);
     return p->v;
 }

diff --git a/lib/common/pointset.h b/lib/common/pointset.h
index 64408d5d872f1f20821be7b9dd57ca982ab0446e..171eeb0bff30a05b864b9e47dccf2742b364a5ab 100644 (file)
--- a/lib/common/pointset.h
+++ b/lib/common/pointset.h
@@ -1,3 +1,8 @@
+/**
+ * @file
+ * @brief @ref point containers @ref PointSet and @ref PointMap
+ */
+
 /*************************************************************************
  * Copyright (c) 2011 AT&T Intellectual Property 
  * All rights reserved. This program and the accompanying materials
@@ -17,8 +22,8 @@
 extern "C" {
 #endif
 
-    typedef Dict_t PointSet;
-    typedef Dict_t PointMap;
+    typedef Dict_t PointSet; ///< set of @ref point. Created by @ref newPS
+    typedef Dict_t PointMap; ///< map of @ref point. Created by @ref newPM
 
 #ifdef GVDLL
 #ifdef GVC_EXPORTS
@@ -28,23 +33,25 @@ extern "C" {
 #endif
 #endif
 
+/// @cond
 #ifndef POINTSET_API
 #define POINTSET_API /* nothing */
 #endif
+/// @endcond
 
        POINTSET_API PointSet *newPS(void);
     POINTSET_API void freePS(PointSet *);
     POINTSET_API void insertPS(PointSet *, point);
-    POINTSET_API void addPS(PointSet *, int, int);
+    POINTSET_API void addPS(PointSet *, int x, int y);
     POINTSET_API int inPS(PointSet *, point);
-    POINTSET_API int isInPS(PointSet *, int, int);
+    POINTSET_API int isInPS(PointSet *, int x, int y);
     POINTSET_API int sizeOf(PointSet *);
     POINTSET_API point *pointsOf(PointSet *);
 
     POINTSET_API PointMap *newPM(void);
     POINTSET_API void clearPM(PointMap *);
     POINTSET_API void freePM(PointMap *);
-    POINTSET_API int insertPM(PointMap *, int, int, int);
+    POINTSET_API int insertPM(PointMap *, int x, int y, int value);
 
 #undef POINTSET_API
 #ifdef __cplusplus