ROOT logo
ROOT » HTML » TClassDocInfo

class TClassDocInfo: public TObject

 Caches class documentation information, like which module it belongs to,
 and whether THtml should generate documentation for the class.

Function Members (Methods)

TClassDocInfo(TClass* cl, const char* htmlfilename = "", const char* fsdecl = "", const char* fsimpl = "", const char* decl = 0, const char* impl = 0)
TClassDocInfo(TDictionary* cl, const char* htmlfilename = "", const char* fsdecl = "", const char* fsimpl = "", const char* decl = 0, const char* impl = 0)
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tCompare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
TDictionary*GetClass() const
const char*GetDeclFileName() const
const char*GetDeclFileSysName() const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
const char*GetHtmlFileName() const
virtual const char*TObject::GetIconName() const
const char*GetImplFileName() const
const char*GetImplFileSysName() const
TModuleDocInfo*GetModule() const
virtual const char*GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tHash() const
Bool_tHaveSource() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
Bool_tIsSelected() const
virtual Bool_tIsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TObject&TObject::operator=(const TObject& rhs)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTObject::Print(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
voidSetDeclFileName(const char* name)
voidSetDeclFileSysName(const char* fsname)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
voidSetHtmlFileName(const char* name)
voidSetImplFileName(const char* name)
voidSetImplFileSysName(const char* fsname)
voidSetModule(TModuleDocInfo* module)
static voidTObject::SetObjectStat(Bool_t stat)
voidSetSelected(Bool_t sel = kTRUE)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const

Data Members

TDictionary*fClassclass (or typedef) represented by this info object
TStringfDeclFileSysNamefile system's location of the header
TStringfHtmlFileNamename of the HTML doc file
TStringfImplFileSysNamefile system's location of the source
TModuleDocInfo*fModulemodule this class is in
Bool_tfSelectedselected for doc output
TListfTypedefstypedefs to this class

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

const char* GetName() const
 Get the class name, or (UNKNOWN) is no TClass object was found.
ULong_t Hash() const
 Forward to TClass::Hash(), return -1 if no TClass object was found.
Int_t Compare(const TObject* obj) const
 Compare two TClassDocInfo objects; used for sorting.
TClassDocInfo(TClass* cl, const char* htmlfilename = "", const char* fsdecl = "", const char* fsimpl = "", const char* decl = 0, const char* impl = 0)
 initialize the object
{ }
TClassDocInfo(TDictionary* cl, const char* htmlfilename = "", const char* fsdecl = "", const char* fsimpl = "", const char* decl = 0, const char* impl = 0)
{ }
virtual ~TClassDocInfo()
TDictionary* GetClass() const
{ return fClass; }
const char* GetHtmlFileName() const
{ return fHtmlFileName; }
const char* GetDeclFileName() const
{ return fDeclFileName; }
const char* GetImplFileName() const
{ return fImplFileName; }
const char* GetDeclFileSysName() const
{ return fDeclFileSysName; }
const char* GetImplFileSysName() const
{ return fImplFileSysName; }
void SetModule(TModuleDocInfo* module)
{ fModule = module; }
TModuleDocInfo* GetModule() const
{ return fModule; }
void SetSelected(Bool_t sel = kTRUE)
{ fSelected = sel; }
Bool_t IsSelected() const
{ return fSelected; }
Bool_t HaveSource() const
void SetHtmlFileName(const char* name)
{ fHtmlFileName = name; }
void SetDeclFileName(const char* name)
{ fDeclFileName = name; }
void SetImplFileName(const char* name)
{ fImplFileName = name; }
void SetDeclFileSysName(const char* fsname)
{ fDeclFileSysName = fsname; }
void SetImplFileSysName(const char* fsname)
{ fImplFileSysName = fsname; }
TList& GetListOfTypedefs()
{ return fTypedefs; }
Bool_t IsSortable() const
{ return kTRUE; }