Modules for reladminif

13 files changed, 43 insertions, 11 deletions

diff --git a/reladminif/adminif.hh b/reladminif/adminif.hh
index 6d4024b..70874ea 100644
--- a/reladminif/adminif.hh
+++ b/reladminif/adminif.hh
@@ -70,6 +70,13 @@ before using a persistence capable class.
 */
 
 const int SYSTEMNAME_MAXLEN=256;
+/**
+  * \defgroup Reladminifs Reladminif Classes
+  */
+
+/**
+  * \ingroup Reladminifs
+  */
 
 class AdminIf              
 	{
diff --git a/reladminif/binaryrepresentation.hh b/reladminif/binaryrepresentation.hh
index d2e3f0f..7778b7e 100644
--- a/reladminif/binaryrepresentation.hh
+++ b/reladminif/binaryrepresentation.hh
@@ -20,6 +20,9 @@ rasdaman GmbH.
 * For more information please see <http://www.rasdaman.org>
 * or contact Peter Baumann via <baumann@rasdaman.com>.
 */
+/**
+  * \ingroup Reladminifs
+  */
 class BinaryRepresentation
 	{
 	public:
diff --git a/reladminif/databaseif.hh b/reladminif/databaseif.hh
index f8b8954..cb3349d 100644
--- a/reladminif/databaseif.hh
+++ b/reladminif/databaseif.hh
@@ -60,7 +60,9 @@ using std::endl;
 using std::ostream;
 
 #include "raslib/error.hh"
-
+/**
+  * \ingroup Reladminifs
+  */
 class DatabaseIf              
 	{
 	public:
diff --git a/reladminif/dbnamedobject.hh b/reladminif/dbnamedobject.hh
index 654547c..cc971cd 100644
--- a/reladminif/dbnamedobject.hh
+++ b/reladminif/dbnamedobject.hh
@@ -34,7 +34,9 @@ Has functionality for setting the name of itsself from VARCHAR structures.
 Takes care of too long names.
 Implements set/getName functionality.
 */
-
+/**
+  * \ingroup Reladminifs
+  */
 class DBNamedObject : public DBObject
 	{
 	public:
diff --git a/reladminif/dbobject.hh b/reladminif/dbobject.hh
index 80e3360..192d901 100644
--- a/reladminif/dbobject.hh
+++ b/reladminif/dbobject.hh
@@ -48,7 +48,9 @@ management by ObjectBroker, modification management, cache size.
 
 a persistent DBObject has a unique OId.  this oid identifies it in the database.
 */
-
+/**
+  * \ingroup Reladminifs
+  */
 class DBObject
 	{
 	public:
diff --git a/reladminif/dbobjectiditerator.hh b/reladminif/dbobjectiditerator.hh
index bb6ba78..4be86be 100644
--- a/reladminif/dbobjectiditerator.hh
+++ b/reladminif/dbobjectiditerator.hh
@@ -39,7 +39,9 @@ this object gets a set of oids.  when an oid is accessed the iterator returns a
 
 */
 
-
+/**
+  * \ingroup Reladminifs
+  */
 template<class T>
 class DBObjectIdIterator
 	{
diff --git a/reladminif/dbobjectiterator.hh b/reladminif/dbobjectiterator.hh
index 4f04370..4a675d3 100644
--- a/reladminif/dbobjectiterator.hh
+++ b/reladminif/dbobjectiterator.hh
@@ -35,7 +35,9 @@ this object gets a set of oids.  when an oid is accessed the iterator returns a
 
 */
 
-
+/**
+  * \ingroup Reladminifs
+  */
 template<class T>
 class DBObjectIterator
 	{
diff --git a/reladminif/dbref.hh b/reladminif/dbref.hh
index 35065a9..617c7fa 100644
--- a/reladminif/dbref.hh
+++ b/reladminif/dbref.hh
@@ -63,7 +63,9 @@ All access methods may throw database related r_Errors.
 */
 
 #define DBOBJID_NONE	OId()
-
+/**
+  * \ingroup Reladminifs
+  */
 template <class T>
 class DBRef
 	{
diff --git a/reladminif/destroyable.hh b/reladminif/destroyable.hh
index 316cfeb..fb3f1e6 100644
--- a/reladminif/destroyable.hh
+++ b/reladminif/destroyable.hh
@@ -37,7 +37,9 @@ rasdaman GmbH.
 This is an interface class.  It is abstract.  It supplies the signature that
 is required to allow other interfaces to be defined without a virtual destructor.
 */
-
+/**
+  * \ingroup Reladminifs
+  */
 class Destroyable 
 	{
 	public:
diff --git a/reladminif/eoid.hh b/reladminif/eoid.hh
index 968dcb5..6ffb397 100644
--- a/reladminif/eoid.hh
+++ b/reladminif/eoid.hh
@@ -46,7 +46,9 @@ EOId is optimized for maps that contain only EOId of one system/database.
 when true multiple connections are implemented the order of compare
 statements in the operator"<" and ">" must be changed.
 */
-
+/**
+  * \ingroup Reladminifs
+  */
 class EOId :	public OId
 	{
 	public:
diff --git a/reladminif/objectbroker.hh b/reladminif/objectbroker.hh
index bb8d429..62c70d4 100644
--- a/reladminif/objectbroker.hh
+++ b/reladminif/objectbroker.hh
@@ -65,7 +65,9 @@ The ObejctBroker can retrieve the oids of all objects of a specific type which a
 in the database.
 The list of objects which are kept by the ObjectBroker are cleared by TransactionIf.
 */
-
+/**
+  * \ingroup Reladminifs
+  */
 class ObjectBroker
 	{
 	public:
diff --git a/reladminif/oidif.hh b/reladminif/oidif.hh
index 7444ec9..c83ccf1 100644
--- a/reladminif/oidif.hh
+++ b/reladminif/oidif.hh
@@ -61,7 +61,9 @@ transaction.  this can be a problem with multiple concurrent open read/write
 transactions.
 */
 
-
+/**
+  * \ingroup Reladminifs
+  */
 class OId
 	{ 
 	public:
diff --git a/reladminif/transactionif.hh b/reladminif/transactionif.hh
index 757325d..0290fd9 100644
--- a/reladminif/transactionif.hh
+++ b/reladminif/transactionif.hh
@@ -46,7 +46,9 @@ class DatabaseIf;
 #include <iostream>
 
 #include "raslib/error.hh"
-
+/**
+  * \ingroup Reladminifs
+  */
 class TransactionIf              
 	{
 	public: