Logo ROOT   6.08/07
Reference Guide
TDocInfo.cxx
Go to the documentation of this file.
1 // @(#)root/html:$Id$
2 // Author: Axel Naumann 2007-01-09
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2007, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #include "TDocInfo.h"
13 
14 #include "TClass.h"
15 #include "TSystem.h"
16 
17 //______________________________________________________________________________
18 //
19 // Caches class documentation information, like which module it belongs to,
20 // and whether THtml should generate documentation for the class.
21 //______________________________________________________________________________
22 
23 
25 
26 const char* TClassDocInfo::GetName() const
27 {
28  // Get the class name, or (UNKNOWN) is no TClass object was found.
29  return fClass ? fClass->GetName() : "(UNKNOWN)";
30 }
31 
33 {
34  // Forward to TClass::Hash(), return -1 if no TClass object was found.
35  return fClass ? fClass->Hash() : (ULong_t)-1;
36 }
37 
39 {
40  // Compare two TClassDocInfo objects; used for sorting.
41  return fClass ? fClass->Compare(obj) : obj < this;
42 }
43 
44 //______________________________________________________________________________
45 //
46 // BEGIN_HTML
47 // <p>Represents modules of the documented product. Modules are sub-groups of
48 // sources of a product, which get separate index pages and user-provided
49 // documentation. For ROOT, a module is a sub-directory; it often corresponds
50 // to a library. TModuleDocInfo, for example, is part of the HTML module,
51 // which is documented <a href="./HTML_index.html">here</a>. The list of
52 // all modules is shown e.g. in the <a href="ClassIndex.html">class index</a>.</p>
53 // <p>A module's documentation is searched by combining its source directory
54 // (see <a href="#TModuleDocInfo:SetInputDir">SetInputDir()</a>) and the
55 // module documentation search path defined by
56 // <a href="./THtml.html#THtml:SetModuleDocPath">THtml::SetModuleDocPath()</a>;
57 // it defaults to "../doc", i.e. for a module's sources in "module/src" its
58 // documentation is searched in "module/doc".
59 // END_HTML
60 //______________________________________________________________________________
61 
62 
virtual const char * GetName() const
Returns name of object.
Definition: TNamed.h:51
TDictionary * fClass
Definition: TDocInfo.h:91
virtual Int_t Compare(const TObject *obj) const
Compare abstract method.
Definition: TDocInfo.cxx:38
virtual Int_t Compare(const TObject *obj) const
Compare two TNamed objects.
Definition: TNamed.cxx:76
ULong_t Hash() const
Return hash value for this object.
Definition: TDocInfo.cxx:32
int Int_t
Definition: RtypesCore.h:41
virtual const char * GetName() const
Returns name of object.
Definition: TDocInfo.cxx:26
virtual ULong_t Hash() const
Return hash value for this object.
Definition: TNamed.h:53
#define ClassImp(name)
Definition: Rtypes.h:279
unsigned long ULong_t
Definition: RtypesCore.h:51
Mother of all ROOT objects.
Definition: TObject.h:37