Logo ROOT  
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
16//______________________________________________________________________________
17//
18// Caches class documentation information, like which module it belongs to,
19// and whether THtml should generate documentation for the class.
20//______________________________________________________________________________
21
22
24
25const char* TClassDocInfo::GetName() const
26{
27 // Get the class name, or (UNKNOWN) is no TClass object was found.
28 return fClass ? fClass->GetName() : "(UNKNOWN)";
29}
30
32{
33 // Forward to TClass::Hash(), return -1 if no TClass object was found.
34 return fClass ? fClass->Hash() : (ULong_t)-1;
35}
36
38{
39 // Compare two TClassDocInfo objects; used for sorting.
40 return fClass ? fClass->Compare(obj) : obj < this;
41}
42
43//______________________________________________________________________________
44//
45// BEGIN_HTML
46// <p>Represents modules of the documented product. Modules are sub-groups of
47// sources of a product, which get separate index pages and user-provided
48// documentation. For ROOT, a module is a sub-directory; it often corresponds
49// to a library. TModuleDocInfo, for example, is part of the HTML module,
50// which is documented <a href="./HTML_index.html">here</a>. The list of
51// all modules is shown e.g. in the <a href="ClassIndex.html">class index</a>.</p>
52// <p>A module's documentation is searched by combining its source directory
53// (see <a href="#TModuleDocInfo:SetInputDir">SetInputDir()</a>) and the
54// module documentation search path defined by
55// <a href="./THtml.html#THtml:SetModuleDocPath">THtml::SetModuleDocPath()</a>;
56// it defaults to "../doc", i.e. for a module's sources in "module/src" its
57// documentation is searched in "module/doc".
58// END_HTML
59//______________________________________________________________________________
60
61
unsigned long ULong_t
Definition: RtypesCore.h:55
#define ClassImp(name)
Definition: Rtypes.h:375
ULong_t Hash() const
Return hash value for this object.
Definition: TDocInfo.cxx:31
TDictionary * fClass
Definition: TDocInfo.h:90
virtual const char * GetName() const
Returns name of object.
Definition: TDocInfo.cxx:25
virtual Int_t Compare(const TObject *obj) const
Compare abstract method.
Definition: TDocInfo.cxx:37
const char * GetName() const override
Returns name of object.
Definition: TNamed.h:47
ULong_t Hash() const override
Return hash value for this object.
Definition: TNamed.h:49
Int_t Compare(const TObject *obj) const override
Compare two TNamed objects.
Definition: TNamed.cxx:85
Mother of all ROOT objects.
Definition: TObject.h:37