summaryrefslogtreecommitdiffstats
path: root/indexmgr
diff options
context:
space:
mode:
authorroot <root@localhost.localdomain>2009-06-14 21:20:50 +0200
committerConstantin <jucovschi@gmail.com>2010-04-01 11:59:01 +0200
commit85510da57f54a986a0f5f8bf72768797260e3aaf (patch)
treedcb6cc0cc4e23dee8842d658e2a80087120e6630 /indexmgr
parentf8e4f8040ed048467cce6479f373b7bf7223f9f6 (diff)
downloadrasdaman-upstream-85510da57f54a986a0f5f8bf72768797260e3aaf.tar.gz
rasdaman-upstream-85510da57f54a986a0f5f8bf72768797260e3aaf.tar.xz
rasdaman-upstream-85510da57f54a986a0f5f8bf72768797260e3aaf.zip
doxygen related changes in indexmgr directory
Diffstat (limited to 'indexmgr')
-rw-r--r--indexmgr/hierindexds.hh15
-rw-r--r--indexmgr/indexds.hh9
-rw-r--r--indexmgr/keyobject.hh12
-rw-r--r--indexmgr/mddobjix.hh7
-rw-r--r--indexmgr/persmddobjix.hh7
-rw-r--r--indexmgr/sdirindexlogic.hh7
-rw-r--r--indexmgr/srcindexlogic.hh7
-rw-r--r--indexmgr/srptindexlogic.hh7
-rw-r--r--indexmgr/transdirix.hh7
9 files changed, 62 insertions, 16 deletions
diff --git a/indexmgr/hierindexds.hh b/indexmgr/hierindexds.hh
index c4aedb6..6d25959 100644
--- a/indexmgr/hierindexds.hh
+++ b/indexmgr/hierindexds.hh
@@ -35,11 +35,16 @@ rasdaman GmbH.
#include "indexmgr/indexds.hh"
-//@ManMemo: Module: {\bf indexmgr}
-/*@Doc:
- Interface class for Data Structure classes of Hierarchical Indexes.
- Classes which wish to use the RPTreeIndexLogic must implement this
- class.
+/**
+ * @file hierindexds.hh
+ *
+ * @ingroup indexmgr
+ *
+ *
+ * @Doc:
+ * Interface class for Data Structure classes of Hierarchical Indexes.
+ * Classes which wish to use the RPTreeIndexLogic must implement this
+ * class.
*/
class HierIndexDS : public IndexDS
diff --git a/indexmgr/indexds.hh b/indexmgr/indexds.hh
index ede1583..c336a93 100644
--- a/indexmgr/indexds.hh
+++ b/indexmgr/indexds.hh
@@ -37,8 +37,13 @@ rasdaman GmbH.
#include "reladminif/lists.h"
#include "reladminif/oidif.hh"
-//@ManMemo: Module: {\bf indexmgr}
-/*@Doc:
+/**
+ * @defgroup indexmgr indexmgr
+ *
+ * @file indexds.hh
+ *
+ * @ingroup indexmgr
+ */
This is an interface class. It is abstract. It supplies the signature that
is required to allow SDirIndexLogic to manage this object.
diff --git a/indexmgr/keyobject.hh b/indexmgr/keyobject.hh
index 51bf89c..030acc6 100644
--- a/indexmgr/keyobject.hh
+++ b/indexmgr/keyobject.hh
@@ -31,10 +31,14 @@ class KeyObject;
#include "raslib/minterval.hh"
#include "reladminif/dbref.hh"
-//@ManMemo: Module: {\bf indexmgr}
-/*@Doc:
-This class is a carrier structure which carries objects and their domains
-through the different levels of the index.
+/**
+ * @file keyobject.hh
+ *
+ * @ingroup indexmgr
+ *
+ * @Doc:
+ * This class is a carrier structure which carries objects and their domains
+ * through the different levels of the index.
*/
class KeyObject
{
diff --git a/indexmgr/mddobjix.hh b/indexmgr/mddobjix.hh
index 0e7dd09..b79b521 100644
--- a/indexmgr/mddobjix.hh
+++ b/indexmgr/mddobjix.hh
@@ -51,8 +51,13 @@ class r_Point;
*
****************************************************************************/
+/**
+ * @file mddobjix.hh
+ *
+ * @ingroup indexmgr
+ */
+
-//@ManMemo: Module: {\bf indexmgr}
/*@Doc:
Each MDD Object is composed of a set of tiles which are accessed through an index.
diff --git a/indexmgr/persmddobjix.hh b/indexmgr/persmddobjix.hh
index b4e4c9b..32a0e93 100644
--- a/indexmgr/persmddobjix.hh
+++ b/indexmgr/persmddobjix.hh
@@ -1 +1,8 @@
//moved to mddobjix
+//
+/**
+ * @file persmddobjix.hh
+ *
+ * @ingroup indexmgr
+ *
+ */
diff --git a/indexmgr/sdirindexlogic.hh b/indexmgr/sdirindexlogic.hh
index f94084c..afd8bd1 100644
--- a/indexmgr/sdirindexlogic.hh
+++ b/indexmgr/sdirindexlogic.hh
@@ -40,7 +40,12 @@ class StorageLayout;
*
***********/
-//@ManMemo: Module: {\bf indexmgr}
+/**
+ * @file sdirindexlogic.hh
+ *
+ * @ingroup indexmgr
+ */
+
/*@Doc:
The SDirIndexLogic class implements a Directory of Interval Objects Index.
diff --git a/indexmgr/srcindexlogic.hh b/indexmgr/srcindexlogic.hh
index 92b0869..e0952d1 100644
--- a/indexmgr/srcindexlogic.hh
+++ b/indexmgr/srcindexlogic.hh
@@ -39,7 +39,12 @@ class r_Point;
class StorageLayout;
class SRCIndexLogic;
-//@ManMemo: Module: {\bf indexmgr}
+/**
+ * @file srcindexlogic.hh
+ *
+ * @ingroup indexmgr
+ */
+
/*@Doc:
The regular computed index uses DBRCIndexDS and StorageLayout to store its persistent data.
diff --git a/indexmgr/srptindexlogic.hh b/indexmgr/srptindexlogic.hh
index 7ad0dc5..5b3c7fc 100644
--- a/indexmgr/srptindexlogic.hh
+++ b/indexmgr/srptindexlogic.hh
@@ -30,7 +30,12 @@ class r_Point;
class StorageLayout;
-//@ManMemo: Module: {\bf indexmgr}
+/**
+ * @file srpindexlogic.hh
+ *
+ * @ingroup indexmgr
+ */
+
/*@Doc:
This class contains the logic for access, insertion and removal of objects
into an index data structure. The logic is based on the R-Plus Tree. Objects
diff --git a/indexmgr/transdirix.hh b/indexmgr/transdirix.hh
index f5e829d..e5fe46d 100644
--- a/indexmgr/transdirix.hh
+++ b/indexmgr/transdirix.hh
@@ -36,7 +36,12 @@ rasdaman GmbH.
#include "indexmgr/indexds.hh"
#include "reladminif/lists.h"
-//@ManMemo: Module: {\bf indexmgr}
+/**
+ * @file transdirix.hh
+ *
+ * @ingroup indexmgr
+ */
+
/*@Doc:
A TransDirIx object is the data structure for an index of a transient MDD