From c07a5c4031ec83d0e8c17ff6ee5ca3b0cb8df95e Mon Sep 17 00:00:00 2001 From: shaan Date: Sun, 7 Jun 2009 14:35:05 +0200 Subject: Modules for relcatalogif --- relcatalogif/atomictype.hh | 7 +++++++ relcatalogif/basetype.hh | 3 +++ relcatalogif/booltype.hh | 3 +++ relcatalogif/chartype.hh | 3 +++ relcatalogif/collectiontype.hh | 3 +++ relcatalogif/complextype.hh | 9 +++++++++ relcatalogif/compositetype.hh | 3 +++ relcatalogif/dbminterval.hh | 3 +++ relcatalogif/doubletype.hh | 3 +++ relcatalogif/floattype.hh | 3 +++ relcatalogif/inlineminterval.hh | 3 +++ relcatalogif/integraltype.hh | 3 +++ relcatalogif/longtype.hh | 3 +++ relcatalogif/mddbasetype.hh | 3 +++ relcatalogif/mdddimensiontype.hh | 3 +++ relcatalogif/mdddomaintype.hh | 3 +++ relcatalogif/mddtype.hh | 3 +++ relcatalogif/octettype.hh | 3 +++ relcatalogif/realtype.hh | 3 +++ relcatalogif/settype.hh | 3 +++ relcatalogif/shorttype.hh | 3 +++ relcatalogif/structtype.hh | 3 +++ relcatalogif/type.hh | 3 +++ relcatalogif/uintegraltype.hh | 3 +++ relcatalogif/ulongtype.hh | 3 +++ relcatalogif/ushorttype.hh | 3 +++ 26 files changed, 88 insertions(+) (limited to 'relcatalogif') diff --git a/relcatalogif/atomictype.hh b/relcatalogif/atomictype.hh index 3a7523b..bbb196c 100644 --- a/relcatalogif/atomictype.hh +++ b/relcatalogif/atomictype.hh @@ -48,6 +48,13 @@ AtomicType is the abstract base class for all non-structured \Ref{BaseType} subclasses, i.e. base types like \Ref{ULongType} or \Ref{BoolType}. */ +/** + * \defgroup Relcatalogifs Relcatalogif Classes + */ + +/** + * \ingroup Relcatalogifs + */ class AtomicType : public BaseType { diff --git a/relcatalogif/basetype.hh b/relcatalogif/basetype.hh index f01bd60..ad124f3 100644 --- a/relcatalogif/basetype.hh +++ b/relcatalogif/basetype.hh @@ -60,6 +60,9 @@ Each \Ref{Tile} has a pointer to its BaseType. Pointers to BaseType are also used in subclasses of \Ref{MDDObject}. */ +/** + * \ingroup Relcatalogifs + */ class BaseType : public Type { public: diff --git a/relcatalogif/booltype.hh b/relcatalogif/booltype.hh index 9810055..e593ecc 100644 --- a/relcatalogif/booltype.hh +++ b/relcatalogif/booltype.hh @@ -52,6 +52,9 @@ of comparison operations, see \Ref{Ops}). The value of a Bool is stored in one char. BoolType is a persistence capable class. */ +/** + * \ingroup Relcatalogifs + */ class BoolType : public UIntegralType { public: diff --git a/relcatalogif/chartype.hh b/relcatalogif/chartype.hh index 2a8fd8c..70ae4e2 100644 --- a/relcatalogif/chartype.hh +++ b/relcatalogif/chartype.hh @@ -52,6 +52,9 @@ result of comparison operations, see \Ref{Ops}). The value of a Char is stored in one char. CharType is a persistence capable class. */ +/** + * \ingroup Relcatalogifs + */ class CharType : public UIntegralType { public: diff --git a/relcatalogif/collectiontype.hh b/relcatalogif/collectiontype.hh index 591d715..f4e49d9 100644 --- a/relcatalogif/collectiontype.hh +++ b/relcatalogif/collectiontype.hh @@ -53,6 +53,9 @@ class MDDType; collections of MDDs (the only subclass at the moment is SetType). */ +/** + * \ingroup Relcatalogifs + */ class CollectionType : public Type { public: diff --git a/relcatalogif/complextype.hh b/relcatalogif/complextype.hh index 9d18e32..c3d5f16 100644 --- a/relcatalogif/complextype.hh +++ b/relcatalogif/complextype.hh @@ -46,6 +46,9 @@ class OId; +/** + * \ingroup Relcatalogifs + */ class GenericComplexType : public AtomicType { public: @@ -60,6 +63,9 @@ protected: }; +/** + * \ingroup Relcatalogifs + */ class ComplexType1 : public GenericComplexType { public: @@ -92,6 +98,9 @@ private: }; +/** + * \ingroup Relcatalogifs + */ class ComplexType2 : public GenericComplexType { public: diff --git a/relcatalogif/compositetype.hh b/relcatalogif/compositetype.hh index 9e07106..fbe83cd 100644 --- a/relcatalogif/compositetype.hh +++ b/relcatalogif/compositetype.hh @@ -48,6 +48,9 @@ CompositeType is the abstract base class for all structured \Ref{BaseType} subclasses, at the moment only \Ref{StructType}. */ +/** + * \ingroup Relcatalogifs + */ class CompositeType : public BaseType { public: diff --git a/relcatalogif/dbminterval.hh b/relcatalogif/dbminterval.hh index c871cef..13df157 100644 --- a/relcatalogif/dbminterval.hh +++ b/relcatalogif/dbminterval.hh @@ -41,6 +41,9 @@ it is used by DBMDDObj and MDDDomainType because the performance impact is negle for a more efficient storage system refere to InlineMInterval */ +/** + * \ingroup Relcatalogifs + */ class DBMinterval : public DBObject, public r_Minterval { public: diff --git a/relcatalogif/doubletype.hh b/relcatalogif/doubletype.hh index 74dcfa2..1ccadce 100644 --- a/relcatalogif/doubletype.hh +++ b/relcatalogif/doubletype.hh @@ -50,6 +50,9 @@ DoubleType is the base type used for 32bit integer cell values. The value of a Double is stored in four chars. */ +/** + * \ingroup Relcatalogifs + */ class DoubleType : public RealType { public: diff --git a/relcatalogif/floattype.hh b/relcatalogif/floattype.hh index 299fe11..af9c57f 100644 --- a/relcatalogif/floattype.hh +++ b/relcatalogif/floattype.hh @@ -50,6 +50,9 @@ FloatType is the base type used for 32bit integer cell values. The value of a Float is stored in four chars. */ +/** + * \ingroup Relcatalogifs + */ class FloatType : public RealType { public: diff --git a/relcatalogif/inlineminterval.hh b/relcatalogif/inlineminterval.hh index c3f1daa..71fdfe9 100644 --- a/relcatalogif/inlineminterval.hh +++ b/relcatalogif/inlineminterval.hh @@ -38,6 +38,9 @@ This class is used by the index data structures to store their domain data fast and efficiently. */ +/** + * \ingroup Relcatalogifs + */ class InlineMinterval : public r_Minterval { public: diff --git a/relcatalogif/integraltype.hh b/relcatalogif/integraltype.hh index 118056e..60eec90 100644 --- a/relcatalogif/integraltype.hh +++ b/relcatalogif/integraltype.hh @@ -47,6 +47,9 @@ IntegralType is the abstract base class for all integral signed double. It's subclasses must implement conversions to/from long. */ +/** + * \ingroup Relcatalogifs + */ class IntegralType : public AtomicType { public: IntegralType(unsigned int newSize): diff --git a/relcatalogif/longtype.hh b/relcatalogif/longtype.hh index 4aa5573..3a2202b 100644 --- a/relcatalogif/longtype.hh +++ b/relcatalogif/longtype.hh @@ -51,6 +51,9 @@ values. The value of a Long is stored in four chars. */ +/** + * \ingroup Relcatalogifs + */ class LongType : public IntegralType { public: diff --git a/relcatalogif/mddbasetype.hh b/relcatalogif/mddbasetype.hh index 1e1642f..a989fdd 100644 --- a/relcatalogif/mddbasetype.hh +++ b/relcatalogif/mddbasetype.hh @@ -51,6 +51,9 @@ class OId; only the base type is specified. */ +/** + * \ingroup Relcatalogifs + */ class MDDBaseType : public MDDType { public: diff --git a/relcatalogif/mdddimensiontype.hh b/relcatalogif/mdddimensiontype.hh index 293812d..de230ce 100644 --- a/relcatalogif/mdddimensiontype.hh +++ b/relcatalogif/mdddimensiontype.hh @@ -51,6 +51,9 @@ class OId; the base type and the dimensionality is specified. */ +/** + * \ingroup Relcatalogifs + */ class MDDDimensionType : public MDDBaseType { public: diff --git a/relcatalogif/mdddomaintype.hh b/relcatalogif/mdddomaintype.hh index 22d5352..43604f2 100644 --- a/relcatalogif/mdddomaintype.hh +++ b/relcatalogif/mdddomaintype.hh @@ -55,6 +55,9 @@ class OId; the base type and the domain is specified. */ +/** + * \ingroup Relcatalogifs + */ class MDDDomainType : public MDDBaseType { public: diff --git a/relcatalogif/mddtype.hh b/relcatalogif/mddtype.hh index 3508d7a..d0e6a6d 100644 --- a/relcatalogif/mddtype.hh +++ b/relcatalogif/mddtype.hh @@ -52,6 +52,9 @@ class OId; specifying more. */ +/** + * \ingroup Relcatalogifs + */ class MDDType : public Type { public: diff --git a/relcatalogif/octettype.hh b/relcatalogif/octettype.hh index 8a5107c..f6615d7 100644 --- a/relcatalogif/octettype.hh +++ b/relcatalogif/octettype.hh @@ -53,6 +53,9 @@ of comparison operations, see \Ref{Ops}). The value of a Octet is stored in one char. OctetType is a persistence capable class. */ +/** + * \ingroup Relcatalogifs + */ class OctetType : public IntegralType { public: diff --git a/relcatalogif/realtype.hh b/relcatalogif/realtype.hh index 08c9752..5cdb0ff 100644 --- a/relcatalogif/realtype.hh +++ b/relcatalogif/realtype.hh @@ -47,6 +47,9 @@ It provides conversions to/from long and unsigned long It's subclasses must implement conversions to/from double */ +/** + * \ingroup Relcatalogifs + */ class RealType : public AtomicType { public: RealType(unsigned int newSize): diff --git a/relcatalogif/settype.hh b/relcatalogif/settype.hh index 7c62200..b4a3d6d 100644 --- a/relcatalogif/settype.hh +++ b/relcatalogif/settype.hh @@ -51,6 +51,9 @@ class OId; objects. */ +/** + * \ingroup Relcatalogifs + */ class SetType : public CollectionType { public: diff --git a/relcatalogif/shorttype.hh b/relcatalogif/shorttype.hh index 75b701e..aa3a6c4 100644 --- a/relcatalogif/shorttype.hh +++ b/relcatalogif/shorttype.hh @@ -52,6 +52,9 @@ values. The value of a Short is stored in four chars. */ +/** + * \ingroup Relcatalogifs + */ class ShortType : public IntegralType { public: diff --git a/relcatalogif/structtype.hh b/relcatalogif/structtype.hh index 7adbfc2..c586dc6 100644 --- a/relcatalogif/structtype.hh +++ b/relcatalogif/structtype.hh @@ -62,6 +62,9 @@ struct. */ +/** + * \ingroup Relcatalogifs + */ class StructType : public CompositeType { // friend ostream& operator << (ostream& stream, StructType& b); diff --git a/relcatalogif/type.hh b/relcatalogif/type.hh index f119f09..b03c8e5 100644 --- a/relcatalogif/type.hh +++ b/relcatalogif/type.hh @@ -62,6 +62,9 @@ Each \Ref{Tile} has a pointer to its BaseType. Pointers to BaseType are also used in subclasses of \Ref{MDDObject}. */ +/** + * \ingroup Relcatalogifs + */ class Type : public DBNamedObject { public: diff --git a/relcatalogif/uintegraltype.hh b/relcatalogif/uintegraltype.hh index 89a4362..c234dc4 100644 --- a/relcatalogif/uintegraltype.hh +++ b/relcatalogif/uintegraltype.hh @@ -48,6 +48,9 @@ double. It's subclasses must implement conversions to/from unsigned long. */ +/** + * \ingroup Relcatalogifs + */ class UIntegralType : public AtomicType { public: UIntegralType(unsigned int newSize): diff --git a/relcatalogif/ulongtype.hh b/relcatalogif/ulongtype.hh index 5e0b369..ed5e66c 100644 --- a/relcatalogif/ulongtype.hh +++ b/relcatalogif/ulongtype.hh @@ -50,6 +50,9 @@ ULongType is the base type used for 32bit unsigned integer cell values. The value of a ULong is stored in four chars. */ +/** + * \ingroup Relcatalogifs + */ class ULongType : public UIntegralType { public: diff --git a/relcatalogif/ushorttype.hh b/relcatalogif/ushorttype.hh index 39f614f..e7c28b9 100644 --- a/relcatalogif/ushorttype.hh +++ b/relcatalogif/ushorttype.hh @@ -49,6 +49,9 @@ UShortType is the base type used for 16bit unsigned integer cell values. The value of a UShort is stored in four chars. */ +/** + * \ingroup Relcatalogifs + */ class UShortType : public UIntegralType { public: -- cgit