class TClassDocOutput: public TDocOutput

Function Members (Methods)

public:

virtual	~TClassDocOutput()
void	TObject::AbstractMethod(const char* method) const
virtual void	TDocOutput::AdjustSourcePath(TString& line, const char* relpath = "../")
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
void	Class2Html(Bool_t force = kFALSE)
Bool_t	ClassDotCharts(ostream& out)
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	TDocOutput::Convert(istream& in, const char* infilename, const char* outfilename, const char* title, const char* relpath = "../", Int_t includeOutput = 0, const char* context = "", TGClient* gclient = 0)
virtual void	TObject::Copy(TObject& object) const
Bool_t	TDocOutput::CopyHtmlFile(const char* sourceName, const char* destName = "")
void	CreateClassHierarchy(ostream& out, const char* docFileName)
virtual void	TDocOutput::CreateClassIndex()
virtual void	TDocOutput::CreateClassTypeDefs()
virtual void	TDocOutput::CreateHierarchy()
virtual void	TDocOutput::CreateModuleIndex()
virtual void	TDocOutput::CreateProductIndex()
virtual void	TDocOutput::CreateTypeIndex()
virtual void	TDocOutput::DecorateEntityBegin(TString& str, Ssiz_t& pos, TDocParser::EParseContext type)
virtual void	TDocOutput::DecorateEntityEnd(TString& str, Ssiz_t& pos, TDocParser::EParseContext type)
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
virtual void	TDocOutput::FixupAuthorSourceInfo(TString& authors)
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
const char*	TDocOutput::GetExtension() const
THtml*	TDocOutput::GetHtml()
virtual const char*	TObject::GetIconName() 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
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
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
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
virtual Bool_t	TDocOutput::IsModified(TClass* classPtr, TDocOutput::EFileType type)
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
void	MakeTree(Bool_t force = kFALSE)
void	TObject::MayNotUse(const char* method) const
virtual void	TDocOutput::NameSpace2FileName(TString& name)
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)
TClassDocOutput&	operator=(const TClassDocOutput&)
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)
virtual void	TDocOutput::ReferenceEntity(TSubString& str, TClass* entity, const char* comment = 0)
virtual void	TDocOutput::ReferenceEntity(TSubString& str, TDataMember* entity, const char* comment = 0)
virtual void	TDocOutput::ReferenceEntity(TSubString& str, TDataType* entity, const char* comment = 0)
virtual void	TDocOutput::ReferenceEntity(TSubString& str, TMethod* entity, const char* comment = 0)
virtual Bool_t	TDocOutput::ReferenceIsRelative(const char* reference) const
virtual const char*	TDocOutput::ReplaceSpecialChars(char c)
void	TDocOutput::ReplaceSpecialChars(TString& text)
void	TDocOutput::ReplaceSpecialChars(ostream& out, const char* string)
void	TDocOutput::ReplaceSpecialChars(TString& text, Ssiz_t& pos)
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	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
static void	TObject::SetObjectStat(Bool_t stat)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
	TClassDocOutput(const TClassDocOutput&)
	TClassDocOutput(THtml& html, TClass* cl, TList* typedefs)
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
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
virtual void	TDocOutput::WriteHtmlFooter(ostream& out, const char* dir = "", const char* lastUpdate = "", const char* author = "", const char* copyright = "")
virtual void	TDocOutput::WriteHtmlHeader(ostream& out, const char* title, const char* dir = "", TClass* cls = 0)
void	TDocOutput::WriteLineNumbers(ostream& out, Long_t nLines, const TString& infileBase) const

protected:

void	TDocOutput::AddLink(TSubString& str, TString& link, const char* comment)
int	TDocOutput::CaseInsensitiveSort(const void* name1, const void* name2)
void	ClassHtmlTree(ostream& out, TClass* classPtr, TClassDocOutput::ETraverse dir = kBoth, int depth = 1)
void	ClassTree(TVirtualPad* canvas, Bool_t force = kFALSE)
Bool_t	CreateDotClassChartIncl(const char* filename)
Bool_t	CreateDotClassChartInh(const char* filename)
Bool_t	CreateDotClassChartInhMem(const char* filename)
Bool_t	CreateDotClassChartLib(const char* filename)
Bool_t	CreateHierarchyDot()
void	CreateSourceOutputStream(ostream& out, const char* extension, TString& filename)
void	DescendHierarchy(ostream& out, TClass* basePtr, Int_t maxLines = 0, Int_t depth = 1)
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
virtual void	ListDataMembers(ostream& classFile)
virtual void	ListFunctions(ostream& classFile)
void	TObject::MakeZombie()
void	TDocOutput::ProcessDocInDir(ostream& out, const char* indir, const char* outdir, const char* linkdir)
Bool_t	TDocOutput::RunDot(const char* filename, ostream* outMap = 0, TDocOutput::EGraphvizTool gvwhat = kDot)
virtual void	WriteClassDescription(ostream& out, const TString& description)
virtual void	WriteClassDocHeader(ostream& classFile)
void	TDocOutput::WriteHtmlFooter(ostream& out, const char* dir, const char* lastUpdate, const char* author, const char* copyright, const char* footer)
void	TDocOutput::WriteHtmlHeader(ostream& out, const char* titleNoSpecial, const char* dir, TClass* cls, const char* header)
void	TDocOutput::WriteLocation(ostream& out, TModuleDocInfo* module, const char* classname = 0)
virtual void	WriteMethod(ostream& out, TString& ret, TString& name, TString& params, const char* file, TString& anchor, TString& comment, TString& codeOneLiner, TDocMethodWrapper* guessedMethod)
void	TDocOutput::WriteModuleLinks(ostream& out)
void	TDocOutput::WriteModuleLinks(ostream& out, TModuleDocInfo* super)
virtual void	TDocOutput::WriteSearch(ostream& out)
void	TDocOutput::WriteTopLinks(ostream& out, TModuleDocInfo* module, const char* classname = 0, Bool_t withLocation = kTRUE)

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TDocOutput::EFileType	TDocOutput::kDoc
static TObject::EStatusBits	TObject::kHasUUID
static TDocOutput::EFileType	TDocOutput::kInclude
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 TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static TObject::(anonymous)	TObject::kSingleKey
static TDocOutput::EFileType	TDocOutput::kSource
static TDocOutput::EFileType	TDocOutput::kTree
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

TClass*	fCurrentClass	class to generate output for
TList*	fCurrentClassesTypedefs	typedefs to the current class
Int_t	fHierarchyLines	counter for no. lines in hierarchy
THtml*	TDocOutput::fHtml	THtml object we belong to
TDocParser*	fParser	parser we use
static TClassDocOutput::ETraverse	kBoth
static TDocOutput::EGraphvizTool	TDocOutput::kCirco
static TDocOutput::EGraphvizTool	TDocOutput::kDot
static TClassDocOutput::ETraverse	kDown
static TDocOutput::EGraphvizTool	TDocOutput::kFdp
static TDocOutput::EGraphvizTool	TDocOutput::kNeato
static TClassDocOutput::ETraverse	kUp

Class Charts

Inheritance Chart:

TObject

←

TDocOutput

←

TClassDocOutput

Function documentation

kUp, kDown, kBoth // direction to traverse class tree in ClassHtmlTree()

void ClassTree(TVirtualPad* canvas, Bool_t force = kFALSE)

Bool_t CreateDotClassChartIncl(const char* filename)

Bool_t CreateDotClassChartInh(const char* filename)

Bool_t CreateDotClassChartInhMem(const char* filename)

Bool_t CreateDotClassChartLib(const char* filename)

Bool_t CreateHierarchyDot()

void CreateSourceOutputStream(ostream& out, const char* extension, TString& filename)

void DescendHierarchy(ostream& out, TClass* basePtr, Int_t maxLines = 0, Int_t depth = 1)

void ListFunctions(ostream& classFile)

void ListDataMembers(ostream& classFile)

void WriteClassDocHeader(ostream& classFile)

void WriteMethod(ostream& out, TString& ret, TString& name, TString& params, const char* file, TString& anchor, TString& comment, TString& codeOneLiner, TDocMethodWrapper* guessedMethod)

TClassDocOutput(THtml& html, TClass* cl, TList* typedefs)

virtual ~TClassDocOutput()

void Class2Html(Bool_t force = kFALSE)

Bool_t ClassDotCharts(ostream& out)

void CreateClassHierarchy(ostream& out, const char* docFileName)

void MakeTree(Bool_t force = kFALSE)