A++ » INCLUDE » TDocOutput

class TDocOutput: public TObject


ROOT_TDocOutput

Generates documentation output using XHTML 1.0 transitional

Function Members (Methods)

public:
virtual~TDocOutput()
voidTObject::AbstractMethod(const char* method) const
virtual voidAdjustSourcePath(TString& line, const char* relpath = "../")
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_tTObject::Compare(const TObject* obj) const
voidConvert(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 voidTObject::Copy(TObject& object) const
Bool_tCopyHtmlFile(const char* sourceName, const char* destName = "")
virtual voidCreateClassIndex()
virtual voidCreateClassTypeDefs()
virtual voidCreateHierarchy()
virtual voidCreateModuleIndex()
virtual voidCreateProductIndex()
virtual voidCreateTypeIndex()
virtual voidDecorateEntityBegin(TString& str, Ssiz_t& pos, TDocParser::EParseContext type)
virtual voidDecorateEntityEnd(TString& str, Ssiz_t& pos, TDocParser::EParseContext type)
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
virtual voidFixupAuthorSourceInfo(TString& authors)
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
const char*GetExtension() const
THtml*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_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_tTObject::Hash() 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
virtual Bool_tIsModified(TClass* classPtr, TDocOutput::EFileType type)
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual voidNameSpace2FileName(TString& name)
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
voidTObject::operator delete(void* ptr)
voidTObject::operator delete(void* ptr, void* vp)
voidTObject::operator delete[](void* ptr)
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)
TDocOutput&operator=(const TDocOutput&)
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)
virtual voidReferenceEntity(TSubString& str, TClass* entity, const char* comment = 0)
virtual voidReferenceEntity(TSubString& str, TDataMember* entity, const char* comment = 0)
virtual voidReferenceEntity(TSubString& str, TDataType* entity, const char* comment = 0)
virtual voidReferenceEntity(TSubString& str, TMethod* entity, const char* comment = 0)
virtual Bool_tReferenceIsRelative(const char* reference) const
virtual const char*ReplaceSpecialChars(char c)
voidReplaceSpecialChars(TString& text)
voidReplaceSpecialChars(ostream& out, const char* string)
voidReplaceSpecialChars(TString& text, Ssiz_t& pos)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
static voidTObject::SetObjectStat(Bool_t stat)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp) const
virtual voidStreamer(TBuffer&)
voidStreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
TDocOutput(THtml& html)
TDocOutput(const TDocOutput&)
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 voidWriteHtmlFooter(ostream& out, const char* dir = "", const char* lastUpdate = "", const char* author = "", const char* copyright = "")
virtual voidWriteHtmlHeader(ostream& out, const char* title, const char* dir = "", TClass* cls = 0)
voidWriteLineNumbers(ostream& out, Long_t nLines, const TString& infileBase) const
protected:
voidAddLink(TSubString& str, TString& link, const char* comment)
intCaseInsensitiveSort(const void* name1, const void* name2)
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTObject::MakeZombie()
voidProcessDocInDir(ostream& out, const char* indir, const char* outdir, const char* linkdir)
Bool_tRunDot(const char* filename, ostream* outMap = 0, TDocOutput::EGraphvizTool gvwhat = kDot)
voidWriteHtmlFooter(ostream& out, const char* dir, const char* lastUpdate, const char* author, const char* copyright, const char* footer)
voidWriteHtmlHeader(ostream& out, const char* titleNoSpecial, const char* dir, TClass* cls, const char* header)
voidWriteLocation(ostream& out, TModuleDocInfo* module, const char* classname = 0)
voidWriteModuleLinks(ostream& out)
voidWriteModuleLinks(ostream& out, TModuleDocInfo* super)
virtual voidWriteSearch(ostream& out)
voidWriteTopLinks(ostream& out, TModuleDocInfo* module, const char* classname = 0, Bool_t withLocation = kTRUE)

Data Members

public:
static TObject::(anonymous)TObject::kBitMask
static TObject::EStatusBitsTObject::kCanDelete
static TObject::EStatusBitsTObject::kCannotPick
static TDocOutput::EFileTypekDoc
static TObject::EStatusBitsTObject::kHasUUID
static TDocOutput::EFileTypekInclude
static TObject::EStatusBitsTObject::kInvalidObject
static TObject::(anonymous)TObject::kIsOnHeap
static TObject::EStatusBitsTObject::kIsReferenced
static TObject::EStatusBitsTObject::kMustCleanup
static TObject::EStatusBitsTObject::kNoContextMenu
static TObject::(anonymous)TObject::kNotDeleted
static TObject::EStatusBitsTObject::kObjInCanvas
static TObject::(anonymous)TObject::kOverwrite
static TObject::(anonymous)TObject::kSingleKey
static TDocOutput::EFileTypekSource
static TDocOutput::EFileTypekTree
static TObject::(anonymous)TObject::kWriteDelete
static TObject::(anonymous)TObject::kZombie
protected:
THtml*fHtmlTHtml object we belong to
static TDocOutput::EGraphvizToolkCirco
static TDocOutput::EGraphvizToolkDot
static TDocOutput::EGraphvizToolkFdp
static TDocOutput::EGraphvizToolkNeato

Class Charts

Inheritance Chart:
TObject
←
TDocOutput
←
TClassDocOutput

Function documentation

int CaseInsensitiveSort(const void* name1, const void* name2)
void AddLink(TSubString& str, TString& link, const char* comment)
void ProcessDocInDir(ostream& out, const char* indir, const char* outdir, const char* linkdir)
Bool_t RunDot(const char* filename, ostream* outMap = 0, TDocOutput::EGraphvizTool gvwhat = kDot)
void WriteHtmlHeader(ostream& out, const char* titleNoSpecial, const char* dir, TClass* cls, const char* header)
void WriteSearch(ostream& out)
void WriteLocation(ostream& out, TModuleDocInfo* module, const char* classname = 0)
void WriteModuleLinks(ostream& out)
void WriteModuleLinks(ostream& out, TModuleDocInfo* super)
void WriteTopLinks(ostream& out, TModuleDocInfo* module, const char* classname = 0, Bool_t withLocation = kTRUE)
TDocOutput(THtml& html)
virtual ~TDocOutput()
void AdjustSourcePath(TString& line, const char* relpath = "../")
void 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)
void CreateClassIndex()
void CreateModuleIndex()
void CreateProductIndex()
void CreateTypeIndex()
void CreateClassTypeDefs()
void CreateHierarchy()
void DecorateEntityBegin(TString& str, Ssiz_t& pos, TDocParser::EParseContext type)
void DecorateEntityEnd(TString& str, Ssiz_t& pos, TDocParser::EParseContext type)
void FixupAuthorSourceInfo(TString& authors)
const char* GetExtension() const
{ return ".html"; }
THtml* GetHtml()
{ return fHtml; }
Bool_t IsModified(TClass* classPtr, TDocOutput::EFileType type)
void NameSpace2FileName(TString& name)
void ReferenceEntity(TSubString& str, TClass* entity, const char* comment = 0)
void ReferenceEntity(TSubString& str, TDataMember* entity, const char* comment = 0)
void ReferenceEntity(TSubString& str, TDataType* entity, const char* comment = 0)
void ReferenceEntity(TSubString& str, TMethod* entity, const char* comment = 0)
Bool_t ReferenceIsRelative(const char* reference) const
const char* ReplaceSpecialChars(char c)
void ReplaceSpecialChars(ostream& out, const char* string)
void ReplaceSpecialChars(TString& text)
void ReplaceSpecialChars(TString& text, Ssiz_t& pos)
void WriteHtmlHeader(ostream& out, const char* title, const char* dir = "", TClass* cls = 0)
void WriteHtmlFooter(ostream& out, const char* dir = "", const char* lastUpdate = "", const char* author = "", const char* copyright = "")