TDocOutput Class Reference

#include <TDocOutput.h>

Inheritance diagram for TDocOutput:

TObject TObject TClassDocOutput TClassDocOutput List of all members.

Public Types

enum  EFileType
enum  EFileType

Public Member Functions

 TDocOutput (THtml &html)
virtual ~TDocOutput ()
virtual void AdjustSourcePath (TString &line, const char *relpath="../")
void Convert (std::istream &in, const char *infilename, const char *outfilename, const char *title, const char *relpath="../", Int_t includeOutput=0, const char *context="", TGClient *gclient=0)
Bool_t CopyHtmlFile (const char *sourceName, const char *destName="")
virtual void CreateClassIndex ()
virtual void CreateModuleIndex ()
virtual void CreateProductIndex ()
virtual void CreateTypeIndex ()
virtual void CreateClassTypeDefs ()
virtual void CreateHierarchy ()
virtual void DecorateEntityBegin (TString &str, Ssiz_t &pos, TDocParser::EParseContext type)
virtual void DecorateEntityEnd (TString &str, Ssiz_t &pos, TDocParser::EParseContext type)
virtual void FixupAuthorSourceInfo (TString &authors)
const char * GetExtension () const
THtml * GetHtml ()
virtual Bool_t IsModified (TClass *classPtr, EFileType type)
virtual void NameSpace2FileName (TString &name)
virtual void ReferenceEntity (TSubString &str, TClass *entity, const char *comment=0)
virtual void ReferenceEntity (TSubString &str, TDataMember *entity, const char *comment=0)
virtual void ReferenceEntity (TSubString &str, TDataType *entity, const char *comment=0)
virtual void ReferenceEntity (TSubString &str, TMethod *entity, const char *comment=0)
virtual Bool_t ReferenceIsRelative (const char *reference) const
virtual const char * ReplaceSpecialChars (char c)
void ReplaceSpecialChars (std::ostream &out, const char *string)
void ReplaceSpecialChars (TString &text)
void ReplaceSpecialChars (TString &text, Ssiz_t &pos)
virtual void WriteHtmlHeader (std::ostream &out, const char *title, const char *dir="", TClass *cls=0)
virtual void WriteHtmlFooter (std::ostream &out, const char *dir="", const char *lastUpdate="", const char *author="", const char *copyright="")
void WriteLineNumbers (std::ostream &out, Long_t nLines, const TString &infileBase) const
 ClassDef (TDocOutput, 0)
 TDocOutput (THtml &html)
virtual ~TDocOutput ()
virtual void AdjustSourcePath (TString &line, const char *relpath="../")
void Convert (std::istream &in, const char *infilename, const char *outfilename, const char *title, const char *relpath="../", Int_t includeOutput=0, const char *context="", TGClient *gclient=0)
Bool_t CopyHtmlFile (const char *sourceName, const char *destName="")
virtual void CreateClassIndex ()
virtual void CreateModuleIndex ()
virtual void CreateProductIndex ()
virtual void CreateTypeIndex ()
virtual void CreateClassTypeDefs ()
virtual void CreateHierarchy ()
virtual void DecorateEntityBegin (TString &str, Ssiz_t &pos, TDocParser::EParseContext type)
virtual void DecorateEntityEnd (TString &str, Ssiz_t &pos, TDocParser::EParseContext type)
virtual void FixupAuthorSourceInfo (TString &authors)
const char * GetExtension () const
THtml * GetHtml ()
virtual Bool_t IsModified (TClass *classPtr, EFileType type)
virtual void NameSpace2FileName (TString &name)
virtual void ReferenceEntity (TSubString &str, TClass *entity, const char *comment=0)
virtual void ReferenceEntity (TSubString &str, TDataMember *entity, const char *comment=0)
virtual void ReferenceEntity (TSubString &str, TDataType *entity, const char *comment=0)
virtual void ReferenceEntity (TSubString &str, TMethod *entity, const char *comment=0)
virtual Bool_t ReferenceIsRelative (const char *reference) const
virtual const char * ReplaceSpecialChars (char c)
void ReplaceSpecialChars (std::ostream &out, const char *string)
void ReplaceSpecialChars (TString &text)
void ReplaceSpecialChars (TString &text, Ssiz_t &pos)
virtual void WriteHtmlHeader (std::ostream &out, const char *title, const char *dir="", TClass *cls=0)
virtual void WriteHtmlFooter (std::ostream &out, const char *dir="", const char *lastUpdate="", const char *author="", const char *copyright="")
void WriteLineNumbers (std::ostream &out, Long_t nLines, const TString &infileBase) const
 ClassDef (TDocOutput, 0)

Protected Types

enum  EGraphvizTool
enum  EGraphvizTool

Protected Member Functions

int CaseInsensitiveSort (const void *name1, const void *name2)
void AddLink (TSubString &str, TString &link, const char *comment)
void ProcessDocInDir (std::ostream &out, const char *indir, const char *outdir, const char *linkdir)
Bool_t RunDot (const char *filename, std::ostream *outMap=0, EGraphvizTool gvwhat=kDot)
void WriteHtmlHeader (std::ostream &out, const char *titleNoSpecial, const char *dir, TClass *cls, const char *header)
void WriteHtmlFooter (std::ostream &out, const char *dir, const char *lastUpdate, const char *author, const char *copyright, const char *footer)
virtual void WriteSearch (std::ostream &out)
void WriteLocation (std::ostream &out, TModuleDocInfo *module, const char *classname=0)
void WriteModuleLinks (std::ostream &out)
void WriteModuleLinks (std::ostream &out, TModuleDocInfo *super)
void WriteTopLinks (std::ostream &out, TModuleDocInfo *module, const char *classname=0, Bool_t withLocation=kTRUE)
int CaseInsensitiveSort (const void *name1, const void *name2)
void AddLink (TSubString &str, TString &link, const char *comment)
void ProcessDocInDir (std::ostream &out, const char *indir, const char *outdir, const char *linkdir)
Bool_t RunDot (const char *filename, std::ostream *outMap=0, EGraphvizTool gvwhat=kDot)
void WriteHtmlHeader (std::ostream &out, const char *titleNoSpecial, const char *dir, TClass *cls, const char *header)
void WriteHtmlFooter (std::ostream &out, const char *dir, const char *lastUpdate, const char *author, const char *copyright, const char *footer)
virtual void WriteSearch (std::ostream &out)
void WriteLocation (std::ostream &out, TModuleDocInfo *module, const char *classname=0)
void WriteModuleLinks (std::ostream &out)
void WriteModuleLinks (std::ostream &out, TModuleDocInfo *super)
void WriteTopLinks (std::ostream &out, TModuleDocInfo *module, const char *classname=0, Bool_t withLocation=kTRUE)

Protected Attributes

THtml * fHtml
THtml * fHtml

Detailed Description

Definition at line 44 of file TDocOutput.h.

Member Enumeration Documentation

enum TDocOutput::EGraphvizTool [protected]

Definition at line 46 of file TDocOutput.h.

enum TDocOutput::EFileType

Definition at line 72 of file TDocOutput.h.

enum TDocOutput::EGraphvizTool [protected]

Definition at line 46 of file TDocOutput.h.

enum TDocOutput::EFileType

Definition at line 72 of file TDocOutput.h.

Constructor & Destructor Documentation

TDocOutput::TDocOutput ( THtml &  html  ) 

Definition at line 255 of file TDocOutput.cxx.

TDocOutput::~TDocOutput (  )  [virtual]

Definition at line 259 of file TDocOutput.cxx.

TDocOutput::TDocOutput ( THtml &  html  ) 

virtual TDocOutput::~TDocOutput (  )  [virtual]

Member Function Documentation

int TDocOutput::CaseInsensitiveSort ( const void *  name1,
const void *  name2 
) [protected]

void TDocOutput::AddLink ( TSubString &  str,
TString &  link,
const char *  comment 
) [protected]

Definition at line 263 of file TDocOutput.cxx.

References TString::BeginsWith(), TString::Length(), TString::Prepend(), ReferenceIsRelative(), TString::ReplaceAll(), ReplaceSpecialChars(), str, and update().

Referenced by ReferenceEntity().

void TDocOutput::ProcessDocInDir ( std::ostream &  out,
const char *  indir,
const char *  outdir,
const char *  linkdir 
) [protected]

Definition at line 1629 of file TDocOutput.cxx.

References TSystem::AccessPathName(), TSystem::BaseName(), TDocParser::Convert(), TSystem::CopyFile(), TString::Data(), TString::EndsWith(), entry, TObject::Error(), TSystem::FreeDirectory(), TSystem::GetDirEntry(), GetHtml(), TSystem::GetPathInfo(), gSystem, kFALSE, TString::kIgnoreCase, kTRUE, line, TSystem::mkdir(), TSystem::OpenDirectory(), outfile, TSystem::PrependPathName(), R__LOCKGUARD, R_ISREG(), ReplaceSpecialChars(), and stat.

Referenced by CreateModuleIndex(), and CreateProductIndex().

Bool_t TDocOutput::RunDot ( const char *  filename,
std::ostream *  outMap = 0,
EGraphvizTool  gvwhat = kDot 
) [protected]

Definition at line 1991 of file TDocOutput.cxx.

References TSystem::BaseName(), TString::Data(), TObject::Error(), TSystem::Exec(), fHtml, Form(), gDebug, THtml::GetDotDir(), getline(), gSystem, THtml::HaveDot(), TObject::Info(), kCirco, kFALSE, kFdp, kNeato, kTRUE, line, TSystem::PrependPathName(), THtml::SetFoundDot(), size_t, and TSystem::Unlink().

Referenced by TClassDocOutput::ClassDotCharts(), TClassDocOutput::CreateHierarchyDot(), and CreateModuleIndex().

void TDocOutput::WriteHtmlHeader ( std::ostream &  out,
const char *  titleNoSpecial,
const char *  dir,
TClass *  cls,
const char *  header 
) [protected]

Definition at line 2059 of file TDocOutput.cxx.

References TDatime::AsString(), fHtml, THtml::GetCharset(), THtml::GetDeclFileName(), GetHtml(), THtml::GetImplFileName(), kFALSE, kNPOS, line, TString::ReplaceAll(), and TObject::Warning().

Referenced by TClassDocOutput::Class2Html(), Convert(), CreateClassIndex(), CreateClassTypeDefs(), CreateHierarchy(), TClassDocOutput::CreateHierarchyDot(), CreateModuleIndex(), CreateProductIndex(), TClassDocOutput::CreateSourceOutputStream(), CreateTypeIndex(), writeHeader(), and WriteHtmlHeader().

void TDocOutput::WriteHtmlFooter ( std::ostream &  out,
const char *  dir,
const char *  lastUpdate,
const char *  author,
const char *  copyright,
const char *  footer 
) [protected]

Definition at line 2167 of file TDocOutput.cxx.

References TString::Form(), TDatime::GetDay(), TDatime::GetHour(), TDatime::GetMinute(), TDatime::GetMonth(), TDatime::GetYear(), kFALSE, kNPOS, TDocParser::kNumSourceInfos, line, and TObject::Warning().

Referenced by TClassDocOutput::Class2Html(), Convert(), CreateClassIndex(), CreateClassTypeDefs(), CreateHierarchy(), TClassDocOutput::CreateHierarchyDot(), CreateModuleIndex(), CreateProductIndex(), CreateTypeIndex(), TDocParser::LocateMethods(), WriteHtmlFooter(), and writeTrailer().

void TDocOutput::WriteSearch ( std::ostream &  out  )  [protected, virtual]

Definition at line 2337 of file TDocOutput.cxx.

References GetHtml(), THtml::GetSearchEngine(), THtml::GetSearchStemURL(), TString::Length(), and TString::Prepend().

Referenced by TClassDocOutput::CreateHierarchyDot(), and WriteTopLinks().

void TDocOutput::WriteLocation ( std::ostream &  out,
TModuleDocInfo *  module,
const char *  classname = 0 
) [protected]

Definition at line 2375 of file TDocOutput.cxx.

References fHtml, TNamed::GetName(), THtml::GetProductName(), kNPOS, TString::Last(), TString::Length(), TString::Remove(), ReplaceSpecialChars(), and TString::ToUpper().

Referenced by TClassDocOutput::WriteClassDocHeader(), and WriteTopLinks().

void TDocOutput::WriteModuleLinks ( std::ostream &  out  )  [protected]

Definition at line 2264 of file TDocOutput.cxx.

References fHtml, THtml::GetListOfModules(), TCollection::GetSize(), name, and THtml::SortListOfModules().

Referenced by CreateClassIndex(), CreateModuleIndex(), and CreateProductIndex().

void TDocOutput::WriteModuleLinks ( std::ostream &  out,
TModuleDocInfo *  super 
) [protected]

Definition at line 2308 of file TDocOutput.cxx.

References TNamed::GetName(), TCollection::GetSize(), TModuleDocInfo::GetSub(), kNPOS, name, TString::ReplaceAll(), and TList::Sort().

void TDocOutput::WriteTopLinks ( std::ostream &  out,
TModuleDocInfo *  module,
const char *  classname = 0,
Bool_t  withLocation = kTRUE 
) [protected]

Definition at line 2417 of file TDocOutput.cxx.

References fHtml, THtml::GetHomepage(), GetHtml(), THtml::GetProductName(), WriteLocation(), and WriteSearch().

Referenced by CreateClassIndex(), CreateClassTypeDefs(), CreateHierarchy(), CreateModuleIndex(), CreateProductIndex(), and TClassDocOutput::WriteClassDocHeader().

void TDocOutput::AdjustSourcePath ( TString &  line,
const char *  relpath = "../" 
) [virtual]

Definition at line 292 of file TDocOutput.cxx.

References line.

Referenced by TDocParser::Convert(), and TDocParser::WriteSourceLine().

void TDocOutput::Convert ( std::istream &  in,
const char *  infilename,
const char *  outfilename,
const char *  title,
const char *  relpath = "../",
Int_t  includeOutput = 0,
const char *  context = "",
TGClient *  gclient = 0 
)

Definition at line 304 of file TDocOutput.cxx.

References TSystem::BaseName(), TSystem::cd(), TDocParser::Convert(), TString::Data(), dir(), TSystem::DirName(), TObject::Error(), TSystem::Exec(), FileStat_t::fMtime, TString::Format(), TSystem::FreeDirectory(), TClass::GetClass(), TSystem::GetDirEntry(), TDocParser::GetLineNumber(), TROOT::GetListOfCanvases(), TSystem::GetListOfTimers(), TSystem::GetPathInfo(), TCollection::GetSize(), gInterpreter, gROOT, gSystem, i, TROOT::IsBatch(), THtml::kCompiledOutput, kFALSE, THtml::kForceOutput, TInterpreter::kNoError, THtml::kSeparateProcessOutput, TSeqCollection::Last(), TPMERegexp::Match(), TSystem::OpenDirectory(), out, outfile, Printf(), TSystem::ProcessEvents(), TROOT::ProcessLine(), pwd(), TSystem::pwd(), TSystem::RemoveTimer(), TVirtualPad::SaveAs(), timer, TSystem::Unlink(), WriteHtmlFooter(), WriteHtmlHeader(), and WriteLineNumbers().

Bool_t TDocOutput::CopyHtmlFile ( const char *  sourceName,
const char *  destName = "" 
)

Definition at line 576 of file TDocOutput.cxx.

References TSystem::BaseName(), TSystem::CopyFile(), TString::Data(), TObject::Error(), fHtml, flags, GetHtml(), THtml::GetOutputDir(), TSystem::GetPathInfo(), gSystem, id, kFALSE, kTRUE, TString::Length(), Long64_t, TSystem::PrependPathName(), R__LOCKGUARD, and size.

Referenced by TClassDocOutput::Class2Html(), and TDocParser::ExpandCPPLine().

void TDocOutput::CreateClassIndex (  )  [virtual]

Definition at line 684 of file TDocOutput.cxx.

References THtml::CreateAuxiliaryFiles(), TString::Data(), TObject::Error(), fHtml, THtml::GetCounter(), THtml::GetCounterFormat(), GetIndexChars(), THtml::GetListOfClasses(), THtml::GetOutputDir(), TCollection::GetSize(), gSystem, i, TSystem::PrependPathName(), Printf(), ReplaceSpecialChars(), TObject::Warning(), WriteHtmlFooter(), WriteHtmlHeader(), WriteModuleLinks(), and WriteTopLinks().

void TDocOutput::CreateModuleIndex (  )  [virtual]

Definition at line 790 of file TDocOutput.cxx.

References TList::Add(), TLibraryDocInfo::AddDependency(), TLibraryDocInfo::AddModule(), TString::Data(), TObject::Error(), fHtml, TList::FindObject(), TString::First(), TModuleDocInfo::GetClasses(), THtml::GetCounter(), THtml::GetCounterFormat(), TLibraryDocInfo::GetDependencies(), GetHtml(), GetIndexChars(), THtml::GetLibraryDependencies(), THtml::GetListOfModules(), TNamed::GetName(), THtml::GetOutputDir(), THtml::GetPathDefinition(), TClass::GetSharedLibs(), gSystem, TModuleDocInfo::IsSelected(), kFALSE, kFdp, kNPOS, TString::Length(), out, TSystem::PrependPathName(), Printf(), ProcessDocInDir(), TString::Remove(), ReplaceSpecialChars(), RunDot(), size_t, title, WriteHtmlFooter(), WriteHtmlHeader(), WriteModuleLinks(), and WriteTopLinks().

void TDocOutput::CreateProductIndex (  )  [virtual]

Definition at line 1109 of file TDocOutput.cxx.

References TString::Data(), TObject::Error(), fHtml, THtml::GetCounterFormat(), GetHtml(), THtml::GetProductName(), gSystem, out, TSystem::PrependPathName(), Printf(), ProcessDocInDir(), WriteHtmlFooter(), WriteHtmlHeader(), WriteModuleLinks(), and WriteTopLinks().

void TDocOutput::CreateTypeIndex (  )  [virtual]

Definition at line 1258 of file TDocOutput.cxx.

References TString::Data(), TObject::Error(), fHtml, THtml::GetCounterFormat(), GetIndexChars(), TROOT::GetListOfTypes(), THtml::GetOutputDir(), TCollection::GetSize(), TROOT::GetType(), gROOT, gSystem, kFALSE, TSystem::PrependPathName(), Printf(), ReplaceSpecialChars(), size_t, sort_strlist_stricmp(), type, WriteHtmlFooter(), and WriteHtmlHeader().

void TDocOutput::CreateClassTypeDefs (  )  [virtual]

Definition at line 1153 of file TDocOutput.cxx.

References TDocParser::DecorateKeywords(), TObject::Error(), fHtml, TList::FindObject(), gDebug, TClassDocInfo::GetClass(), GetHtml(), THtml::GetListOfModules(), TClassDocInfo::GetListOfTypedefs(), THtml::GetModuleNameForClass(), TClassDocInfo::GetName(), TNamed::GetName(), THtml::GetOutputDir(), THtml::GetPathDefinition(), TClass::GetSharedLibs(), gSystem, TObject::Info(), TCollection::IsEmpty(), NameSpace2FileName(), outfile, TSystem::PrependPathName(), ReplaceSpecialChars(), THtml::ShortType(), StrDup(), WriteHtmlFooter(), WriteHtmlHeader(), and WriteTopLinks().

void TDocOutput::CreateHierarchy (  )  [virtual]

Definition at line 628 of file TDocOutput.cxx.

References TClassDocOutput::CreateClassHierarchy(), TString::Data(), TObject::Error(), fHtml, TClassDocInfo::GetClass(), THtml::GetCounter(), THtml::GetCounterFormat(), TClassDocInfo::GetHtmlFileName(), THtml::GetListOfClasses(), TClassDocInfo::GetName(), THtml::GetOutputDir(), gSystem, TClassDocInfo::HaveSource(), out, TSystem::PrependPathName(), Printf(), TObject::Warning(), WriteHtmlFooter(), WriteHtmlHeader(), and WriteTopLinks().

void TDocOutput::DecorateEntityBegin ( TString &  str,
Ssiz_t &  pos,
TDocParser::EParseContext  type 
) [virtual]

Definition at line 1346 of file TDocOutput.cxx.

References TObject::Error(), TDocParser::kCode, TDocParser::kComment, TDocParser::kCPP, TDocParser::kDirective, TDocParser::kKeyword, TDocParser::kString, TDocParser::kVerbatim, and str.

Referenced by TDocParser::DecorateKeywords(), TDocParser::ExpandCPPLine(), and TDocParser::HandleDirective().

void TDocOutput::DecorateEntityEnd ( TString &  str,
Ssiz_t &  pos,
TDocParser::EParseContext  type 
) [virtual]

Definition at line 1385 of file TDocOutput.cxx.

References TObject::Error(), TDocParser::kCode, TDocParser::kComment, TDocParser::kCPP, TDocParser::kDirective, TDocParser::kKeyword, TDocParser::kString, TDocParser::kVerbatim, and str.

Referenced by TDocParser::DecorateKeywords(), and TDocParser::ExpandCPPLine().

void TDocOutput::FixupAuthorSourceInfo ( TString &  authors  )  [virtual]

Definition at line 1424 of file TDocOutput.cxx.

References fHtml, TString::First(), THtml::GetXwho(), TString::Index(), TString::kBoth, kFALSE, kNPOS, kTRUE, TString::Length(), TString::Strip(), and TString::Tokenize().

Referenced by TDocParser::LocateMethods().

const char* TDocOutput::GetExtension (  )  const [inline]

Definition at line 96 of file TDocOutput.h.

THtml* TDocOutput::GetHtml (  )  [inline]

Definition at line 97 of file TDocOutput.h.

References fHtml.

Referenced by CopyHtmlFile(), CreateClassTypeDefs(), TClassDocOutput::CreateDotClassChartIncl(), CreateModuleIndex(), CreateProductIndex(), TClassDocOutput::CreateSourceOutputStream(), IsModified(), TClassDocOutput::MakeTree(), ProcessDocInDir(), ReferenceEntity(), TDocDirective::SetParser(), TClassDocOutput::WriteClassDocHeader(), WriteHtmlFooter(), WriteHtmlHeader(), WriteSearch(), and WriteTopLinks().

Bool_t TDocOutput::IsModified ( TClass *  classPtr,
EFileType  type 
) [virtual]

Definition at line 1489 of file TDocOutput.cxx.

References TSystem::BaseName(), classname, dir(), TObject::Error(), fHtml, flags, THtml::GetDeclFileName(), GetHtml(), TClass::GetImplFileLine(), THtml::GetImplFileName(), THtml::GetOutputDir(), TSystem::GetPathInfo(), gSystem, id, kDoc, kFALSE, kInclude, kSource, kTree, kTRUE, Long64_t, NameSpace2FileName(), TSystem::PrependPathName(), R__LOCKGUARD, and size.

Referenced by TClassDocOutput::Class2Html(), and TClassDocOutput::ClassTree().

void TDocOutput::NameSpace2FileName ( TString &  name  )  [virtual]

Definition at line 1571 of file TDocOutput.cxx.

References TDocParser::AnchorFromLine(), TString::CountChar(), fHtml, TString::Format(), hash, i, TString::Index(), kNPOS, TString::Last(), TString::Length(), name, TString::Remove(), TString::ReplaceAll(), and THtml::ShortType().

Referenced by TClassDocOutput::Class2Html(), TClassDocOutput::ClassDotCharts(), TClassDocOutput::ClassHtmlTree(), TClassDocOutput::ClassTree(), CreateClassTypeDefs(), TClassDocOutput::CreateSourceOutputStream(), TDocMacroDirective::GetResult(), TDocLatexDirective::GetResult(), IsModified(), TClassDocOutput::ListDataMembers(), TClassDocOutput::ListFunctions(), TDocParser::LocateMethods(), ReferenceEntity(), TClassDocOutput::WriteClassDescription(), TClassDocOutput::WriteClassDocHeader(), and TClassDocOutput::WriteMethod().

void TDocOutput::ReferenceEntity ( TSubString &  str,
TClass *  entity,
const char *  comment = 0 
) [virtual]

Definition at line 1730 of file TDocOutput.cxx.

References AddLink(), fHtml, THtml::GetHtmlFileName(), and str.

Referenced by TDocParser::DecorateKeywords().

void TDocOutput::ReferenceEntity ( TSubString &  str,
TDataMember *  entity,
const char *  comment = 0 
) [virtual]

Definition at line 1756 of file TDocOutput.cxx.

References AddLink(), TString::Data(), fHtml, TDataMember::GetClass(), TDataMember::GetFullTypeName(), THtml::GetHtmlFileName(), NameSpace2FileName(), and str.

void TDocOutput::ReferenceEntity ( TSubString &  str,
TDataType *  entity,
const char *  comment = 0 
) [virtual]

Definition at line 1807 of file TDocOutput.cxx.

References AddLink(), fHtml, TList::FindObject(), TDataType::GetFullTypeName(), GetHtml(), THtml::GetListOfClasses(), TDataType::GetType(), NameSpace2FileName(), TDataType::Property(), THtml::ShortType(), and str.

void TDocOutput::ReferenceEntity ( TSubString &  str,
TMethod *  entity,
const char *  comment = 0 
) [virtual]

Definition at line 1850 of file TDocOutput.cxx.

References AddLink(), TString::Data(), fHtml, TMethod::GetClass(), THtml::GetHtmlFileName(), TClass::GetListOfMethods(), TFunction::GetPrototype(), TString::Length(), NameSpace2FileName(), and str.

Bool_t TDocOutput::ReferenceIsRelative ( const char *  reference  )  const [virtual]

Definition at line 1902 of file TDocOutput.cxx.

Referenced by AddLink().

const char * TDocOutput::ReplaceSpecialChars ( char  c  )  [virtual]

Definition at line 1914 of file TDocOutput.cxx.

Referenced by AddLink(), TClassDocOutput::ClassHtmlTree(), TClassDocOutput::CreateClassHierarchy(), CreateClassIndex(), CreateClassTypeDefs(), CreateModuleIndex(), CreateTypeIndex(), TDocParser::DecorateKeywords(), TClassDocOutput::DescendHierarchy(), TDocParser::ExpandCPPLine(), TDocLatexDirective::GetResult(), TDocParser::HandleDirective(), TClassDocOutput::ListDataMembers(), TClassDocOutput::ListFunctions(), ProcessDocInDir(), ReplaceSpecialChars(), TClassDocOutput::WriteClassDescription(), TClassDocOutput::WriteClassDocHeader(), WriteHtmlHeader(), WriteLocation(), and TClassDocOutput::WriteMethod().

void TDocOutput::ReplaceSpecialChars ( std::ostream &  out,
const char *  string 
)

Definition at line 1971 of file TDocOutput.cxx.

References ReplaceSpecialChars().

void TDocOutput::ReplaceSpecialChars ( TString &  text  ) 

Definition at line 1959 of file TDocOutput.cxx.

References ReplaceSpecialChars(), and text().

void TDocOutput::ReplaceSpecialChars ( TString &  text,
Ssiz_t &  pos 
)

Definition at line 1939 of file TDocOutput.cxx.

References c, ReplaceSpecialChars(), and text().

void TDocOutput::WriteHtmlHeader ( std::ostream &  out,
const char *  title,
const char *  dir = "",
TClass *  cls = 0 
) [virtual]

Definition at line 2118 of file TDocOutput.cxx.

References fHtml, THtml::GetEtcDir(), THtml::GetHeader(), GetHtml(), gSystem, TString::Length(), TSystem::PrependPathName(), ReplaceSpecialChars(), and WriteHtmlHeader().

void TDocOutput::WriteHtmlFooter ( std::ostream &  out,
const char *  dir = "",
const char *  lastUpdate = "",
const char *  author = "",
const char *  copyright = "" 
) [virtual]

Definition at line 2221 of file TDocOutput.cxx.

References TString::EndsWith(), fHtml, THtml::GetEtcDir(), THtml::GetFooter(), GetHtml(), gSystem, TString::Length(), TSystem::PrependPathName(), TString::Remove(), and WriteHtmlFooter().

void TDocOutput::WriteLineNumbers ( std::ostream &  out,
Long_t  nLines,
const TString &  infileBase 
) const

Definition at line 2289 of file TDocOutput.cxx.

References i.

Referenced by Convert(), and TDocParser::LocateMethods().

TDocOutput::ClassDef ( TDocOutput  ,
0   
)

int TDocOutput::CaseInsensitiveSort ( const void *  name1,
const void *  name2 
) [protected]

void TDocOutput::AddLink ( TSubString &  str,
TString &  link,
const char *  comment 
) [protected]

void TDocOutput::ProcessDocInDir ( std::ostream &  out,
const char *  indir,
const char *  outdir,
const char *  linkdir 
) [protected]

Bool_t TDocOutput::RunDot ( const char *  filename,
std::ostream *  outMap = 0,
EGraphvizTool  gvwhat = kDot 
) [protected]

void TDocOutput::WriteHtmlHeader ( std::ostream &  out,
const char *  titleNoSpecial,
const char *  dir,
TClass *  cls,
const char *  header 
) [protected]

void TDocOutput::WriteHtmlFooter ( std::ostream &  out,
const char *  dir,
const char *  lastUpdate,
const char *  author,
const char *  copyright,
const char *  footer 
) [protected]

virtual void TDocOutput::WriteSearch ( std::ostream &  out  )  [protected, virtual]

void TDocOutput::WriteLocation ( std::ostream &  out,
TModuleDocInfo *  module,
const char *  classname = 0 
) [protected]

void TDocOutput::WriteModuleLinks ( std::ostream &  out  )  [protected]

void TDocOutput::WriteModuleLinks ( std::ostream &  out,
TModuleDocInfo *  super 
) [protected]

void TDocOutput::WriteTopLinks ( std::ostream &  out,
TModuleDocInfo *  module,
const char *  classname = 0,
Bool_t  withLocation = kTRUE 
) [protected]

virtual void TDocOutput::AdjustSourcePath ( TString &  line,
const char *  relpath = "../" 
) [virtual]

void TDocOutput::Convert ( std::istream &  in,
const char *  infilename,
const char *  outfilename,
const char *  title,
const char *  relpath = "../",
Int_t  includeOutput = 0,
const char *  context = "",
TGClient *  gclient = 0 
)

Bool_t TDocOutput::CopyHtmlFile ( const char *  sourceName,
const char *  destName = "" 
)

virtual void TDocOutput::CreateClassIndex (  )  [virtual]

virtual void TDocOutput::CreateModuleIndex (  )  [virtual]

virtual void TDocOutput::CreateProductIndex (  )  [virtual]

virtual void TDocOutput::CreateTypeIndex (  )  [virtual]

virtual void TDocOutput::CreateClassTypeDefs (  )  [virtual]

virtual void TDocOutput::CreateHierarchy (  )  [virtual]

virtual void TDocOutput::DecorateEntityBegin ( TString &  str,
Ssiz_t &  pos,
TDocParser::EParseContext  type 
) [virtual]

virtual void TDocOutput::DecorateEntityEnd ( TString &  str,
Ssiz_t &  pos,
TDocParser::EParseContext  type 
) [virtual]

virtual void TDocOutput::FixupAuthorSourceInfo ( TString &  authors  )  [virtual]

const char* TDocOutput::GetExtension (  )  const [inline]

Definition at line 96 of file TDocOutput.h.

THtml* TDocOutput::GetHtml (  )  [inline]

Definition at line 97 of file TDocOutput.h.

References fHtml.

virtual Bool_t TDocOutput::IsModified ( TClass *  classPtr,
EFileType  type 
) [virtual]

virtual void TDocOutput::NameSpace2FileName ( TString &  name  )  [virtual]

virtual void TDocOutput::ReferenceEntity ( TSubString &  str,
TClass *  entity,
const char *  comment = 0 
) [virtual]

virtual void TDocOutput::ReferenceEntity ( TSubString &  str,
TDataMember *  entity,
const char *  comment = 0 
) [virtual]

virtual void TDocOutput::ReferenceEntity ( TSubString &  str,
TDataType *  entity,
const char *  comment = 0 
) [virtual]

virtual void TDocOutput::ReferenceEntity ( TSubString &  str,
TMethod *  entity,
const char *  comment = 0 
) [virtual]

virtual Bool_t TDocOutput::ReferenceIsRelative ( const char *  reference  )  const [virtual]

virtual const char* TDocOutput::ReplaceSpecialChars ( char  c  )  [virtual]

void TDocOutput::ReplaceSpecialChars ( std::ostream &  out,
const char *  string 
)

void TDocOutput::ReplaceSpecialChars ( TString &  text  ) 

void TDocOutput::ReplaceSpecialChars ( TString &  text,
Ssiz_t &  pos 
)

virtual void TDocOutput::WriteHtmlHeader ( std::ostream &  out,
const char *  title,
const char *  dir = "",
TClass *  cls = 0 
) [virtual]

virtual void TDocOutput::WriteHtmlFooter ( std::ostream &  out,
const char *  dir = "",
const char *  lastUpdate = "",
const char *  author = "",
const char *  copyright = "" 
) [virtual]

void TDocOutput::WriteLineNumbers ( std::ostream &  out,
Long_t  nLines,
const TString &  infileBase 
) const

TDocOutput::ClassDef ( TDocOutput  ,
0   
)

Member Data Documentation

THtml* TDocOutput::fHtml [protected]

Definition at line 53 of file TDocOutput.h.

Referenced by TClassDocOutput::Class2Html(), TClassDocOutput::ClassDotCharts(), TClassDocOutput::ClassHtmlTree(), TClassDocOutput::ClassTree(), CopyHtmlFile(), CreateClassIndex(), CreateClassTypeDefs(), TClassDocOutput::CreateDotClassChartIncl(), TClassDocOutput::CreateDotClassChartInh(), TClassDocOutput::CreateDotClassChartInhMem(), CreateHierarchy(), TClassDocOutput::CreateHierarchyDot(), CreateModuleIndex(), CreateProductIndex(), TClassDocOutput::CreateSourceOutputStream(), CreateTypeIndex(), TClassDocOutput::DescendHierarchy(), FixupAuthorSourceInfo(), GetHtml(), IsModified(), TClassDocOutput::ListDataMembers(), TClassDocOutput::ListFunctions(), TClassDocOutput::MakeTree(), NameSpace2FileName(), ReferenceEntity(), RunDot(), TClassDocOutput::WriteClassDescription(), TClassDocOutput::WriteClassDocHeader(), WriteHtmlFooter(), WriteHtmlHeader(), WriteLocation(), WriteModuleLinks(), and WriteTopLinks().

THtml* TDocOutput::fHtml [protected]

Definition at line 53 of file TDocOutput.h.

The documentation for this class was generated from the following files:
Generated on Tue Jul 5 16:36:10 2011 for ROOT_528-00b_version by  doxygen 1.5.1