diff --git a/core/cont/src/TArray.cxx b/core/cont/src/TArray.cxx index 80170c2a8efe865414a2559d5f5f18a52559d87e..0214014adf8bb812bc6773f7e4b4bf9a1602aced 100644 --- a/core/cont/src/TArray.cxx +++ b/core/cont/src/TArray.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArray +\ingroup Containers Abstract array base class. Used by TArrayC, TArrayS, TArrayI, TArrayL, TArrayF and TArrayD. Data member is public for historical reasons. diff --git a/core/cont/src/TArrayC.cxx b/core/cont/src/TArrayC.cxx index 314201ff53b3e299d3118e9366dd63200f25a709..1c1ad59995a5d34fde4515dd526ab6afdca2d8ad 100644 --- a/core/cont/src/TArrayC.cxx +++ b/core/cont/src/TArrayC.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArrayC +\ingroup Containers Array of chars or bytes (8 bits per element). */ diff --git a/core/cont/src/TArrayD.cxx b/core/cont/src/TArrayD.cxx index b0c8810345da20bc365be421cfdd688adc437caa..f85fd6d57ac6a6658da67faf67f1374aae4ccb27 100644 --- a/core/cont/src/TArrayD.cxx +++ b/core/cont/src/TArrayD.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArrayD +\ingroup Containers Array of doubles (64 bits per element). */ diff --git a/core/cont/src/TArrayF.cxx b/core/cont/src/TArrayF.cxx index 4aeb32be7b0fa2099b6500a312eb8615c10c0c94..8ce77fe71f0e69374784bef4371b9e8f2b4fde37 100644 --- a/core/cont/src/TArrayF.cxx +++ b/core/cont/src/TArrayF.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArrayF +\ingroup Containers Array of floats (32 bits per element). */ diff --git a/core/cont/src/TArrayI.cxx b/core/cont/src/TArrayI.cxx index f63dd0471eadf5b2e17a162455b25d6ced1bf222..94affb34fa76d14f2075377420d72892bce5c3d6 100644 --- a/core/cont/src/TArrayI.cxx +++ b/core/cont/src/TArrayI.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArrayI +\ingroup Containers Array of integers (32 bits per element). */ diff --git a/core/cont/src/TArrayL.cxx b/core/cont/src/TArrayL.cxx index d24039c0905b6a7ba42dbf8b36efc6e6a5728b1b..ca217d4b7e550bf7607b0834ec3c027047946abf 100644 --- a/core/cont/src/TArrayL.cxx +++ b/core/cont/src/TArrayL.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArrayL +\ingroup Containers Array of longs (32 or 64 bits per element). */ diff --git a/core/cont/src/TArrayL64.cxx b/core/cont/src/TArrayL64.cxx index 47c63d0bd2ef3a180a58dec3f0a577396f747ebd..598d31d8fdc0e52f045d7ab354f7e31150325cf0 100644 --- a/core/cont/src/TArrayL64.cxx +++ b/core/cont/src/TArrayL64.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArrayL64 +\ingroup Containers Array of long64s (64 bits per element). */ diff --git a/core/cont/src/TArrayS.cxx b/core/cont/src/TArrayS.cxx index 1d1b6bdf5dacf79e06b9d83e6d3dc0a91a35d2b0..c235047566d55497cb10c826bdd5f02d14824a8b 100644 --- a/core/cont/src/TArrayS.cxx +++ b/core/cont/src/TArrayS.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TArrayS +\ingroup Containers Array of shorts (16 bits per element). */ diff --git a/core/cont/src/TBits.cxx b/core/cont/src/TBits.cxx index e8583b18d6d5f746fd7982beadefa20e04b4a997..7542ee3b79febbfad28f27d11e92525118d9e88e 100644 --- a/core/cont/src/TBits.cxx +++ b/core/cont/src/TBits.cxx @@ -4,6 +4,7 @@ // Feb 6 2001: Changed all int to unsigned int. /** \class TBits +\ingroup Containers Container of bits. This class provides a simple container of bits. diff --git a/core/cont/src/TBtree.cxx b/core/cont/src/TBtree.cxx index e287088ee454191050eb083e9cc93b6be5843500..741fa5493c70fce80368919699ff6e27f8328a2f 100644 --- a/core/cont/src/TBtree.cxx +++ b/core/cont/src/TBtree.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TBtree +\ingroup Containers B-tree class. TBtree inherits from the TSeqCollection ABC. ## B-tree Implementation notes diff --git a/core/cont/src/TClassTable.cxx b/core/cont/src/TClassTable.cxx index f78c929d4d9af654ae0844ec741f83c72387f0c5..6cf41dfb827fefdfe287738648a0221a1f7aec02 100644 --- a/core/cont/src/TClassTable.cxx +++ b/core/cont/src/TClassTable.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TClassTable +\ingroup Containers This class registers for all classes their name, id and dictionary function in a hash table. Classes are automatically added by the ctor of a special init class when a global of this init class is diff --git a/core/cont/src/TClonesArray.cxx b/core/cont/src/TClonesArray.cxx index 257c9ef8ff2282c371ea03f8a52cc86a6e6d9234..50435a37e8aac1e098f6842d83e3160aedd9ccf4 100644 --- a/core/cont/src/TClonesArray.cxx +++ b/core/cont/src/TClonesArray.cxx @@ -10,8 +10,9 @@ *************************************************************************/ /** \class TClonesArray -An array of clone (identical) objects. Memory for the objects // -// stored in the array is allocated only once in the lifetime of the +\ingroup Containers +An array of clone (identical) objects. Memory for the objects +stored in the array is allocated only once in the lifetime of the clones array. All objects must be of the same class. For the rest this class has the same properties as TObjArray. diff --git a/core/cont/src/TCollection.cxx b/core/cont/src/TCollection.cxx index fbf1b09e8c1e638a5e4595a993c282ff9f0d3300..1dd388196808a9e29b230046e188631653fff34f 100644 --- a/core/cont/src/TCollection.cxx +++ b/core/cont/src/TCollection.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TCollection +\ingroup Containers Collection abstract base class. This class describes the base protocol all collection classes have to implement. The ROOT collection classes always store pointers to objects that inherit diff --git a/core/cont/src/TExMap.cxx b/core/cont/src/TExMap.cxx index 15723e81076bc317d8c9d07a9be69836d4a32682..ae84b2d6d5f2e381ef17014c39493b66e940bcd8 100644 --- a/core/cont/src/TExMap.cxx +++ b/core/cont/src/TExMap.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TExMap + This class stores a (key,value) pair using an external hash. The (key,value) are Long64_t's and therefore can contain object pointers or any longs. The map uses an open addressing hashing diff --git a/core/cont/src/THashList.cxx b/core/cont/src/THashList.cxx index 71c01ce54e3cef06eb6fc1423c5d3349dc6b878e..c10b39d04787d4b2708e0e0ea5e6127e3db8f852 100644 --- a/core/cont/src/THashList.cxx +++ b/core/cont/src/THashList.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class THashList +\ingroup Containers THashList implements a hybrid collection class consisting of a hash table and a list to store TObject's. The hash table is used for quick access and lookup of objects while the list allows the objects diff --git a/core/cont/src/THashTable.cxx b/core/cont/src/THashTable.cxx index 606df9b7d437790ec2b0b63d629a2cae90adaf45..151bab11b8b02c52ab191ea195503af8c4b94a57 100644 --- a/core/cont/src/THashTable.cxx +++ b/core/cont/src/THashTable.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class THashTable +\ingroup Containers THashTable implements a hash table to store TObject's. The hash value is calculated using the value returned by the TObject's Hash() function. Each class inheriting from TObject can override diff --git a/core/cont/src/TIterator.cxx b/core/cont/src/TIterator.cxx index 251d635db43a57cbe97b257764dec220fdf78b20..b6892fcbc435832872b1ef45baf6043ff6cf2baf 100644 --- a/core/cont/src/TIterator.cxx +++ b/core/cont/src/TIterator.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TIterator +\ingroup Containers Iterator abstract base class. This base class provides the interface for collection iterators. */ diff --git a/core/cont/src/TList.cxx b/core/cont/src/TList.cxx index d3a9a09f0344578f4234707737f260ed152d9577..d088f98803781a0f945000966b4307bfdec57e79 100644 --- a/core/cont/src/TList.cxx +++ b/core/cont/src/TList.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TList +\ingroup Containers A doubly linked list. All classes inheriting from TObject can be diff --git a/core/cont/src/TMap.cxx b/core/cont/src/TMap.cxx index 449380214fae22f0131d919decb18aa1def3d1ee..7b7442a56a19ee702605189eb332bb4b760a6c58 100644 --- a/core/cont/src/TMap.cxx +++ b/core/cont/src/TMap.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TMap +\ingroup Containers TMap implements an associative array of (key,value) pairs using a THashTable for efficient retrieval (therefore TMap does not conserve the order of the entries). The hash value is calculated diff --git a/core/cont/src/TObjArray.cxx b/core/cont/src/TObjArray.cxx index 31d259fcbc6a458688070966b98ec327085dea85..21234e8fe0f00c32a1c6125c7faf4b1021682fb3 100644 --- a/core/cont/src/TObjArray.cxx +++ b/core/cont/src/TObjArray.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TObjArray +\ingroup Containers An array of TObjects. The array expands automatically when objects are added (shrinking can be done by hand using Expand(), how nice to have meaningful names -:)). diff --git a/core/cont/src/TObjectTable.cxx b/core/cont/src/TObjectTable.cxx index da800231a34d315ea4a67eb37b07d0f01181f15b..0b554c68ef149e3ae04c2e36c9d2a3c49c3810de 100644 --- a/core/cont/src/TObjectTable.cxx +++ b/core/cont/src/TObjectTable.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TObjectTable +\ingroup Containers This class registers all instances of TObject and its derived classes in a hash table. The Add() and Remove() members are called from the TObject ctor and dtor, respectively. Using the Print() diff --git a/core/cont/src/TOrdCollection.cxx b/core/cont/src/TOrdCollection.cxx index 62d5840979655948e1dff38ed19451a97e22d63a..4dce78b2eac3a4853fb16fefeb9d1c8c078616ee 100644 --- a/core/cont/src/TOrdCollection.cxx +++ b/core/cont/src/TOrdCollection.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TOrdCollection +\ingroup Containers Ordered collection. An ordered collection has TList insertion semantics but is implemented using an array of TObject*'s. It uses less space than a TList (since there is no need for the prev and diff --git a/core/cont/src/TRefArray.cxx b/core/cont/src/TRefArray.cxx index ea458a4064ed40972cb713126fdcafeb886463f5..94b0977e048032a512683efe40e58b17580feb9b 100644 --- a/core/cont/src/TRefArray.cxx +++ b/core/cont/src/TRefArray.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TRefArray +\ingroup Containers An array of references to TObjects. The array expands automatically when objects are added (shrinking can be done by hand using Expand() ) diff --git a/core/cont/src/TRefTable.cxx b/core/cont/src/TRefTable.cxx index 07a149b0f3495b1048eb3dfb75823d9994a537b6..f7ad144eb5617d545444bf648d14d3af2bbe0ca5 100644 --- a/core/cont/src/TRefTable.cxx +++ b/core/cont/src/TRefTable.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TRefTable +\ingroup Containers A TRefTable maintains the association between a referenced object and the parent object supporting this referenced object. diff --git a/core/cont/src/TSeqCollection.cxx b/core/cont/src/TSeqCollection.cxx index 44b6caf33a70702cd6739e9eaca460a4e2f5856e..dc27ea19427eb56be01114fee31a7c141ade286f 100644 --- a/core/cont/src/TSeqCollection.cxx +++ b/core/cont/src/TSeqCollection.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TSeqCollection +\ingroup Containers Sequenceable collection abstract base class. TSeqCollection's have an ordering relation, i.e. there is a first and last element. */ diff --git a/core/cont/src/TSortedList.cxx b/core/cont/src/TSortedList.cxx index 46c38a00b46abb3ec477c2b571e501d568eec523..a9fd2a88babf8e626f3c0bd9111f416215939dc7 100644 --- a/core/cont/src/TSortedList.cxx +++ b/core/cont/src/TSortedList.cxx @@ -10,6 +10,7 @@ *************************************************************************/ /** \class TSortedList +\ingroup Containers A sorted doubly linked list. All sortable classes inheriting from TObject can be inserted in a TSortedList. */