Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file inheritance tree (.pdf)

Sections: class description function members data members class charts

class THtml: public TObject


THtml

Html generates documentation for all ROOT classes
using XHTML 1.0 transitional

Function Members (Methods)

public:

virtual	~THtml()
void	TObject::AbstractMethod(const char* method) const
void	AddMacroPath(const char* path)
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
void	Convert(const char* filename, const char* title, const char* dirname = "", const char* relpath = "../", Int_t includeOutput = kNoOutput, const char* context = "")
virtual void	TObject::Copy(TObject& object) const
Bool_t	CopyFileFromEtcDir(const char* filename) const
virtual void	CreateAuxiliaryFiles() const
void	CreateHierarchy()
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
const TString&	GetAuthorTag() const
const TString&	GetCharset() const
virtual TClass*	GetClass(const char* name) const
const TString&	GetClassDocTag() const
const TString&	GetCopyrightTag() const
const char*	GetCounter() const
const char*	GetCounterFormat() const
virtual bool	GetDeclFileName(TClass* cl, Bool_t filesys, TString& out_name) const
void	GetDerivedClasses(TClass* cl, map<TClass*,Int_t>& derived) const
static const char*	GetDirDelimiter()
const TString&	GetDocStyle() const
const TString&	GetDotDir() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	GetEtcDir() const
const THtml::TFileDefinition&	GetFileDefinition() const
const TString&	GetFooter() const
const TString&	GetHeader() const
const TString&	GetHomepage() const
virtual const char*	GetHtmlFileName(const char* classname) const
virtual void	GetHtmlFileName(TClass* classPtr, TString& filename) const
virtual const char*	TObject::GetIconName() const
virtual bool	GetImplFileName(TClass* cl, Bool_t filesys, TString& out_name) const
const TString&	GetInputPath() const
const TString&	GetLastUpdateTag() const
TList*	GetLibraryDependencies()
const TList*	GetListOfClasses() const
const TList*	GetListOfModules() const
THtml::TFileSysDB*	GetLocalFiles() const
const TString&	GetMacroPath() const
TVirtualMutex*	GetMakeClassMutex() const
const THtml::TModuleDefinition&	GetModuleDefinition() const
const TString&	GetModuleDocPath() const
void	GetModuleMacroPath(const TString& module, TString& out_path) const
virtual void	GetModuleNameForClass(TString& module, TClass* cl) const
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
const TString&	GetOutputDir(Bool_t createDir = kTRUE) const
const THtml::TPathDefinition&	GetPathDefinition() const
const THtml::PathInfo_t&	GetPathInfo() const
const TString&	GetProductName() const
const TString&	GetSearchEngine() const
const TString&	GetSearchStemURL() const
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
const char*	GetURL(const char* lib = 0) const
const TString&	GetViewCVS() const
const TString&	GetWikiURL() const
const TString&	GetXwho() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
Bool_t	HaveDot()
void	HelperDeleted(THtml::THelperBase* who)
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
Bool_t	IsBatch() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
static Bool_t	IsNamespace(const TClass* cl)
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
static void	LoadAllLibs()
virtual void	TObject::ls(Option_t* option = "") const
void	MakeAll(Bool_t force = kFALSE, const char* filter = "*", int numthreads = 1)
void	MakeClass(const char* className, Bool_t force = kFALSE)
void	MakeIndex(const char* filter = "*")
void	MakeTree(const char* className, Bool_t force = kFALSE)
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
void	TObject::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)
THtml&	operator=(const THtml&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TObject::Print(Option_t* option = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	ReplaceSpecialChars(ostream&, const char*)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	SetAuthorTag(const char* tag)
void	SetBatch(Bool_t batch = kTRUE)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
void	SetCharset(const char* charset)
void	SetClassDocTag(const char* tag)
void	SetCopyrightTag(const char* tag)
void	SetCounterFormat(const char* format)
void	SetDeclFileName(TClass* cl, const char* filename)
void	SetDocPath(const char* path)
void	SetDocStyle(const char* style)
void	SetDotDir(const char* dir)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	SetEscape(char = '\\')
void	SetEtcDir(const char* dir)
void	SetFileDefinition(const THtml::TFileDefinition& fd)
void	SetFooter(const char* file)
void	SetFoundDot(Bool_t found = kTRUE)
void	SetHeader(const char* file)
void	SetHomepage(const char* url)
void	SetImplFileName(TClass* cl, const char* filename)
void	SetIncludePath(const char* dir)
void	SetInputDir(const char* dir)
void	SetLastUpdateTag(const char* tag)
void	SetLibURL(const char* lib, const char* url)
void	SetMacroPath(const char* path)
void	SetModuleDefinition(const THtml::TModuleDefinition& md)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetOutputDir(const char* dir)
void	SetPathDefinition(const THtml::TPathDefinition& pd)
void	SetProductName(const char* product)
void	SetRootURL(const char* url)
void	SetSearchEngine(const char* url)
void	SetSearchStemURL(const char* url)
void	SetSourceDir(const char* dir)
virtual void	TObject::SetUniqueID(UInt_t uid)
void	SetViewCVS(const char* url)
void	SetWikiURL(const char* url)
void	SetXwho(const char* xwho)
const char*	ShortType(const char* name) const
virtual void	ShowMembers(TMemberInspector& insp) const
void	SortListOfModules()
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
	THtml()
	THtml(const THtml&)
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

virtual void	CreateJavascript() const
void	CreateListOfClasses(const char* filter)
void	CreateListOfTypes()
virtual void	CreateStyleSheet() const
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
virtual bool	GetDeclImplFileName(TClass* cl, bool filesys, bool decl, TString& out_name) const
TClassDocInfo*	GetNextClass()
void	MakeClass(void* cdi, Bool_t force = kFALSE)
static void*	MakeClassThreaded(void* info)
void	TObject::MakeZombie()
void	SetLocalFiles() const

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static THtml::EConvertOutput	kCompiledOutput
static THtml::EConvertOutput	kForceOutput
static TObject::EStatusBits	TObject::kHasUUID
static THtml::EConvertOutput	kInterpretedOutput
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static THtml::EConvertOutput	kNoOutput
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static THtml::EConvertOutput	kSeparateProcessOutput
static TObject::(anonymous)	TObject::kSingleKey
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

Bool_t	fBatch	Whether to enable GUI output
TString	fCounter	counter string
TString	fCounterFormat	counter printf-like format
THtml::DocEntityInfo_t	fDocEntityInfo	data for documented entities
THtml::DocSyntax_t	fDocSyntax	doc syntax configuration
THtml::TFileDefinition*	fFileDef	object translating classes to file names
TGClient*	fGClient	gClient, cached and queried through CINT
THtml::LinkInfo_t	fLinkInfo	link (URL) configuration
THtml::TFileSysDB*	fLocalFiles	files found locally for a given source path
TVirtualMutex*	fMakeClassMutex	Mutex for MakeClassThreaded
THtml::TModuleDefinition*	fModuleDef	object translating classes to module names
THtml::OutputStyle_t	fOutputStyle	output style configuration
THtml::TPathDefinition*	fPathDef	object translating classes to module names
THtml::PathInfo_t	fPathInfo	path configuration
TString	fProductName	name of the product to document
Int_t	fThreadedClassCount	counter of processed classes for MakeClassThreaded
TIter*	fThreadedClassIter	fClasses iterator for MakeClassThreaded

Class Charts

Inheritance Chart:

TObject

←

THtml

Function documentation

bool GetDeclFileName(const TClass* cl, TString& out_filename, TString& out_fsys, TFileSysEntry** fse = 0)

bool GetMacroPath(const TString& module, TString& out_dir)

TString fInputPath; // directories to look for classes; prepended to Decl/ ImplFileName()

THtml()

virtual ~THtml()

void LoadAllLibs()

void Convert(const char* filename, const char* title, const char* dirname = "", const char* relpath = "../", Int_t includeOutput = kNoOutput, const char* context = "")

 Functions to generate documentation

void MakeAll(Bool_t force = kFALSE, const char* filter = "*", int numthreads = 1)

void MakeIndex(const char* filter = "*")

void MakeTree(const char* className, Bool_t force = kFALSE)

void SetModuleDefinition(const THtml::TModuleDefinition& md)

 Configuration setters

void SetFileDefinition(const THtml::TFileDefinition& fd)

void SetPathDefinition(const THtml::TPathDefinition& pd)

void SetProductName(const char* product)

{ fProductName = product; }

void SetOutputDir(const char* dir)

void SetInputDir(const char* dir)

void SetSourceDir(const char* dir)

{ SetInputDir(dir); }

void SetIncludePath(const char* dir)

{ fPathInfo.fIncludePath = dir; }

void SetEtcDir(const char* dir)

{ fPathInfo.fEtcDir = dir; }

void SetDocPath(const char* path)

{ fPathInfo.fDocPath = path; }

void SetDotDir(const char* dir)

{ fPathInfo.fDotDir = dir; fPathInfo.fFoundDot = PathInfo_t::kDotUnknown; }

void SetRootURL(const char* url)

{ fLinkInfo.fROOTURL = url; }

void SetLibURL(const char* lib, const char* url)

{ fLinkInfo.fLibURLs[lib] = url; }

void SetXwho(const char* xwho)

{ fLinkInfo.fXwho = xwho; }

void SetMacroPath(const char* path)

{fPathInfo.fMacroPath = path;}

void AddMacroPath(const char* path)

void SetCounterFormat(const char* format)

{ fCounterFormat = format; }

void SetClassDocTag(const char* tag)

{ fDocSyntax.fClassDocTag = tag; }

void SetAuthorTag(const char* tag)

{ fDocSyntax.fAuthorTag = tag; }

void SetLastUpdateTag(const char* tag)

{ fDocSyntax.fLastUpdateTag = tag; }

void SetCopyrightTag(const char* tag)

{ fDocSyntax.fCopyrightTag = tag; }

void SetHeader(const char* file)

{ fOutputStyle.fHeader = file; }

void SetFooter(const char* file)

{ fOutputStyle.fFooter = file; }

void SetHomepage(const char* url)

{ fLinkInfo.fHomepage = url; }

void SetSearchStemURL(const char* url)

{ fLinkInfo.fSearchStemURL = url; }

void SetSearchEngine(const char* url)

{ fLinkInfo.fSearchEngine = url; }

void SetViewCVS(const char* url)

{ fLinkInfo.fViewCVS = url; }

void SetWikiURL(const char* url)

{ fLinkInfo.fWikiURL = url; }

void SetCharset(const char* charset)

{ fOutputStyle.fCharset = charset; }

void SetDocStyle(const char* style)

{ fDocSyntax.fDocStyle = style; }

const TModuleDefinition& GetModuleDefinition() const

 Configuration getters

const TFileDefinition& GetFileDefinition() const

const TPathDefinition& GetPathDefinition() const

const TString& GetProductName() const

{ return fProductName; }

const TString& GetInputPath() const

{ return fPathInfo.fInputPath; }

const TString& GetOutputDir(Bool_t createDir = kTRUE) const

const char* GetEtcDir() const

const TString& GetModuleDocPath() const

{ return fPathInfo.fDocPath; }

const TString& GetDotDir() const

{ return fPathInfo.fDotDir; }

const char* GetURL(const char* lib = 0) const

const TString& GetXwho() const

{ return fLinkInfo.fXwho; }

const char* GetCounterFormat() const

{ return fCounterFormat; }

const TString& GetClassDocTag() const

{ return fDocSyntax.fClassDocTag; }

const TString& GetAuthorTag() const

{ return fDocSyntax.fAuthorTag; }

const TString& GetLastUpdateTag() const

{ return fDocSyntax.fLastUpdateTag; }

const TString& GetCopyrightTag() const

{ return fDocSyntax.fCopyrightTag; }

const TString& GetHeader() const

{ return fOutputStyle.fHeader; }

const TString& GetFooter() const

{ return fOutputStyle.fFooter; }

const TString& GetHomepage() const

{ return fLinkInfo.fHomepage; }

const TString& GetSearchStemURL() const

{ return fLinkInfo.fSearchStemURL; }

const TString& GetSearchEngine() const

{ return fLinkInfo.fSearchEngine; }

const TString& GetViewCVS() const

{ return fLinkInfo.fViewCVS; }

const TString& GetWikiURL() const

{ return fLinkInfo.fWikiURL; }

const TString& GetCharset() const

{ return fOutputStyle.fCharset; }

const TString& GetDocStyle() const

{ return fDocSyntax.fDocStyle; }

Bool_t CopyFileFromEtcDir(const char* filename) const

 Functions that should only be used by TDocOutput etc.

void CreateAuxiliaryFiles() const

TClass* GetClass(const char* name) const

const char* ShortType(const char* name) const

const char* GetCounter() const

{ return fCounter; }

void GetModuleMacroPath(const TString& module, TString& out_path) const

{ GetPathDefinition().GetMacroPath(module, out_path); }

void GetDerivedClasses(TClass* cl, map<TClass*,Int_t>& derived) const

const char* GetDirDelimiter()

 ";" on windows, ":" everywhere else

bool GetImplFileName(TClass* cl, Bool_t filesys, TString& out_name) const

void GetHtmlFileName(TClass* classPtr, TString& filename) const

const char* GetHtmlFileName(const char* classname) const

TList* GetLibraryDependencies()

{ return &fDocEntityInfo.fLibDeps; }

void SortListOfModules()

{ fDocEntityInfo.fModules.Sort(); }

const TList* GetListOfModules() const

{ return &fDocEntityInfo.fModules; }

const TList* GetListOfClasses() const

{ return &fDocEntityInfo.fClasses; }

TFileSysDB* GetLocalFiles() const

{ if (!fLocalFiles) SetLocalFiles(); return fLocalFiles; }

TVirtualMutex* GetMakeClassMutex() const

{ return fMakeClassMutex; }

void GetModuleNameForClass(TString& module, TClass* cl) const

const PathInfo_t& GetPathInfo() const

{ return fPathInfo; }

Bool_t HaveDot()

void HelperDeleted(THtml::THelperBase* who)

Bool_t IsNamespace(const TClass* cl)

void SetDeclFileName(TClass* cl, const char* filename)

void SetFoundDot(Bool_t found = kTRUE)

void SetImplFileName(TClass* cl, const char* filename)

void SetBatch(Bool_t batch = kTRUE)

{ fBatch = batch; }

Bool_t IsBatch() const

 unused

{ return fBatch; }

void ReplaceSpecialChars(ostream& , const char* )

void SetEscape(char = '\\')

{}

void CreateJavascript() const

void CreateStyleSheet() const

void CreateListOfTypes()

void CreateListOfClasses(const char* filter)

bool GetDeclImplFileName(TClass* cl, bool filesys, bool decl, TString& out_name) const

void MakeClass(void* cdi, Bool_t force = kFALSE)

TClassDocInfo * GetNextClass()

void SetLocalFiles() const

void * MakeClassThreaded(void* info)