TClassDocOutput Class Reference

#include <TClassDocOutput.h>

Inheritance diagram for TClassDocOutput:

TDocOutput TDocOutput TObject TObject TObject TObject List of all members.

Public Member Functions

 TClassDocOutput (THtml &html, TClass *cl, TList *typedefs)
virtual ~TClassDocOutput ()
void Class2Html (Bool_t force=kFALSE)
Bool_t ClassDotCharts (std::ostream &out)
void CreateClassHierarchy (std::ostream &out, const char *docFileName)
void MakeTree (Bool_t force=kFALSE)
 ClassDef (TClassDocOutput, 0)
 TClassDocOutput (THtml &html, TClass *cl, TList *typedefs)
virtual ~TClassDocOutput ()
void Class2Html (Bool_t force=kFALSE)
Bool_t ClassDotCharts (std::ostream &out)
void CreateClassHierarchy (std::ostream &out, const char *docFileName)
void MakeTree (Bool_t force=kFALSE)
 ClassDef (TClassDocOutput, 0)

Protected Types

enum  ETraverse
enum  ETraverse

Protected Member Functions

void ClassHtmlTree (std::ostream &out, TClass *classPtr, 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 (std::ostream &out, const char *extension, TString &filename)
void DescendHierarchy (std::ostream &out, TClass *basePtr, Int_t maxLines=0, Int_t depth=1)
virtual void ListFunctions (std::ostream &classFile)
virtual void ListDataMembers (std::ostream &classFile)
virtual void WriteClassDocHeader (std::ostream &classFile)
virtual void WriteMethod (std::ostream &out, TString &ret, TString &name, TString &params, const char *file, TString &anchor, TString &comment, TString &codeOneLiner, TDocMethodWrapper *guessedMethod)
virtual void WriteClassDescription (std::ostream &out, const TString &description)
void ClassHtmlTree (std::ostream &out, TClass *classPtr, 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 (std::ostream &out, const char *extension, TString &filename)
void DescendHierarchy (std::ostream &out, TClass *basePtr, Int_t maxLines=0, Int_t depth=1)
virtual void ListFunctions (std::ostream &classFile)
virtual void ListDataMembers (std::ostream &classFile)
virtual void WriteClassDocHeader (std::ostream &classFile)
virtual void WriteMethod (std::ostream &out, TString &ret, TString &name, TString &params, const char *file, TString &anchor, TString &comment, TString &codeOneLiner, TDocMethodWrapper *guessedMethod)
virtual void WriteClassDescription (std::ostream &out, const TString &description)

Protected Attributes

Int_t fHierarchyLines
TClass * fCurrentClass
TList * fCurrentClassesTypedefs
TDocParser * fParser
TClass * fCurrentClass
TList * fCurrentClassesTypedefs
TDocParser * fParser

Friends

class TDocParser

Detailed Description

Definition at line 22 of file TClassDocOutput.h.

Member Enumeration Documentation

enum TClassDocOutput::ETraverse [protected]

Definition at line 24 of file TClassDocOutput.h.

enum TClassDocOutput::ETraverse [protected]

Definition at line 24 of file TClassDocOutput.h.

Constructor & Destructor Documentation

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

Definition at line 49 of file TClassDocOutput.cxx.

References fCurrentClass, fParser, and TDocParser.

TClassDocOutput::~TClassDocOutput (  )  [virtual]

Definition at line 60 of file TClassDocOutput.cxx.

References fParser.

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

virtual TClassDocOutput::~TClassDocOutput (  )  [virtual]

Member Function Documentation

void TClassDocOutput::ClassHtmlTree ( std::ostream &  out,
TClass *  classPtr,
ETraverse  dir = kBoth,
int  depth = 1 
) [protected]

Definition at line 458 of file TClassDocOutput.cxx.

References DescendHierarchy(), fHierarchyLines, TDocOutput::fHtml, Form(), THtml::GetClass(), THtml::GetHtmlFileName(), TClass::GetListOfBases(), kBoth, kDown, kFALSE, kTRUE, kUp, TString::Length(), TDocOutput::NameSpace2FileName(), and TDocOutput::ReplaceSpecialChars().

Referenced by WriteClassDescription().

void TClassDocOutput::ClassTree ( TVirtualPad *  canvas,
Bool_t  force = kFALSE 
) [protected]

Definition at line 580 of file TClassDocOutput.cxx.

References TClass::Draw(), fCurrentClass, TDocOutput::fHtml, gErrorIgnoreLevel, THtml::GetCounterFormat(), THtml::GetOutputDir(), gSystem, TDocOutput::IsModified(), TDocOutput::kTree, kWarning, TDocOutput::NameSpace2FileName(), TSystem::PrependPathName(), Printf(), and TVirtualPad::SaveAs().

Referenced by MakeTree().

Bool_t TClassDocOutput::CreateDotClassChartIncl ( const char *  filename  )  [protected]

Definition at line 903 of file TClassDocOutput.cxx.

References TString::Data(), fCurrentClass, TDocOutput::fHtml, THtml::GetDeclFileName(), TDocOutput::GetHtml(), THtml::GetImplFileName(), getline(), kFALSE, kTRUE, line, R__LOCKGUARD, and size_t.

Referenced by ClassDotCharts().

Bool_t TClassDocOutput::CreateDotClassChartInh ( const char *  filename  )  [protected]

Definition at line 613 of file TClassDocOutput.cxx.

References fCurrentClass, TDocOutput::fHtml, THtml::GetDerivedClasses(), THtml::GetHtmlFileName(), TClass::GetListOfBases(), TCollection::GetSize(), TClass::InheritsFrom(), kFALSE, kTRUE, and level.

Referenced by ClassDotCharts().

Bool_t TClassDocOutput::CreateDotClassChartInhMem ( const char *  filename  )  [protected]

Definition at line 722 of file TClassDocOutput.cxx.

References fCurrentClass, TDocOutput::fHtml, TBaseClass::GetClassPointer(), THtml::GetHtmlFileName(), TClass::GetMethodAny(), and kTRUE.

Referenced by ClassDotCharts().

Bool_t TClassDocOutput::CreateDotClassChartLib ( const char *  filename  )  [protected]

Definition at line 987 of file TClassDocOutput.cxx.

References fCurrentClass, TString::First(), TClass::GetSharedLibs(), kNPOS, kTRUE, TString::Length(), and TString::Remove().

Referenced by ClassDotCharts().

Bool_t TClassDocOutput::CreateHierarchyDot (  )  [protected]

Definition at line 1089 of file TClassDocOutput.cxx.

References TString::Data(), TObject::Error(), TDocOutput::fHtml, TList::First(), TClassDocInfo::GetClass(), THtml::GetCounter(), THtml::GetCounterFormat(), TClass::GetListOfBases(), THtml::GetListOfClasses(), TClassDocInfo::GetName(), THtml::GetOutputDir(), gSystem, TCollection::IsEmpty(), kFALSE, kTRUE, out, TSystem::PrependPathName(), Printf(), TDocOutput::RunDot(), title, TObject::Warning(), TDocOutput::WriteHtmlFooter(), TDocOutput::WriteHtmlHeader(), and TDocOutput::WriteSearch().

void TClassDocOutput::CreateSourceOutputStream ( std::ostream &  out,
const char *  extension,
TString &  filename 
) [protected]

Definition at line 1172 of file TClassDocOutput.cxx.

References TSystem::AccessPathName(), TString::Data(), fCurrentClass, TDocOutput::fHtml, TDocOutput::GetHtml(), THtml::GetOutputDir(), gSystem, TSystem::MakeDirectory(), TDocOutput::NameSpace2FileName(), open, TSystem::PrependPathName(), R__LOCKGUARD, TString::Remove(), title, TObject::Warning(), and TDocOutput::WriteHtmlHeader().

void TClassDocOutput::DescendHierarchy ( std::ostream &  out,
TClass *  basePtr,
Int_t  maxLines = 0,
Int_t  depth = 1 
) [protected]

Definition at line 1207 of file TClassDocOutput.cxx.

References fHierarchyLines, TDocOutput::fHtml, TList::FindObject(), Form(), TClassDocInfo::GetClass(), TClassDocInfo::GetHtmlFileName(), TClass::GetListOfBases(), THtml::GetListOfClasses(), TClassDocInfo::GetName(), and TDocOutput::ReplaceSpecialChars().

Referenced by ClassHtmlTree(), and CreateClassHierarchy().

void TClassDocOutput::ListFunctions ( std::ostream &  classFile  )  [protected, virtual]

Definition at line 118 of file TClassDocOutput.cxx.

References access, TSystem::BaseName(), TDocParser::DecorateKeywords(), fCurrentClass, TDocOutput::fHtml, fParser, THtml::GetDeclFileName(), THtml::GetHtmlFileName(), TDocMethodWrapper::GetMethod(), TDocParser::GetMethods(), TDocMethodWrapper::GetOverloadIdx(), gSystem, THtml::IsNamespace(), kFALSE, TDocParser::kPublic, method, TDocOutput::NameSpace2FileName(), TClass::Property(), and TDocOutput::ReplaceSpecialChars().

Referenced by WriteClassDescription().

void TClassDocOutput::ListDataMembers ( std::ostream &  classFile  )  [protected, virtual]

Definition at line 243 of file TClassDocOutput.cxx.

References access, TDocParser::DecorateKeywords(), fCurrentClass, TDocOutput::fHtml, fParser, G__BIT_ISSTATIC, TDataMember::GetArrayDim(), TDataMember::GetClass(), ROOT::GetClass(), TDocParser::GetDataMembers(), TCollection::GetEntries(), TDocParser::GetEnums(), TDataMember::GetFullTypeName(), THtml::GetHtmlFileName(), TDataMember::GetMaxIndex(), TDataMember::GetTypeName(), THtml::IsNamespace(), kNPOS, TDocParser::kPrivate, TDocParser::kProtected, TDocParser::kPublic, kTRUE, TSubString::Length(), TString::Length(), TDocOutput::NameSpace2FileName(), TDataMember::Property(), TDocOutput::ReplaceSpecialChars(), THtml::ShortType(), TSubString::Start(), and what.

Referenced by WriteClassDescription().

void TClassDocOutput::WriteClassDocHeader ( std::ostream &  classFile  )  [protected, virtual]

Definition at line 1429 of file TClassDocOutput.cxx.

References TString::BeginsWith(), TString::Contains(), fCurrentClass, TDocOutput::fHtml, TList::FindObject(), THtml::GetDeclFileName(), TDocOutput::GetHtml(), THtml::GetImplFileName(), THtml::GetListOfModules(), THtml::GetModuleNameForClass(), THtml::GetPathDefinition(), TClass::GetSharedLibs(), THtml::GetViewCVS(), THtml::GetWikiURL(), THtml::HaveDot(), THtml::IsNamespace(), kFALSE, kNPOS, TString::Length(), TDocOutput::NameSpace2FileName(), TString::Prepend(), TString::Remove(), TString::ReplaceAll(), TDocOutput::ReplaceSpecialChars(), StrDup(), TDocOutput::WriteLocation(), and TDocOutput::WriteTopLinks().

Referenced by Class2Html().

void TClassDocOutput::WriteMethod ( std::ostream &  out,
TString &  ret,
TString &  name,
TString &  params,
const char *  file,
TString &  anchor,
TString &  comment,
TString &  codeOneLiner,
TDocMethodWrapper *  guessedMethod 
) [protected, virtual]

Definition at line 1577 of file TClassDocOutput.cxx.

References comment, TDocParser::DecorateKeywords(), fCurrentClass, fParser, TMethodArg::GetDefault(), TMethodArg::GetFullTypeName(), TMethod::GetListOfMethodArgs(), TDocMethodWrapper::GetMethod(), TDocMethodWrapper::GetOverloadIdx(), kFALSE, kTRUE, TString::Length(), name, TDocOutput::NameSpace2FileName(), params, TFunction::Property(), TString::Remove(), and TDocOutput::ReplaceSpecialChars().

void TClassDocOutput::WriteClassDescription ( std::ostream &  out,
const TString &  description 
) [protected, virtual]

Definition at line 1333 of file TClassDocOutput.cxx.

References ClassDotCharts(), ClassHtmlTree(), TDocParser::DecorateKeywords(), fCurrentClass, fCurrentClassesTypedefs, TDocOutput::fHtml, fParser, THtml::GetClass(), THtml::GetHtmlFileName(), TClass::GetListOfBases(), TCollection::IsEmpty(), THtml::IsNamespace(), kFALSE, kTRUE, TString::Length(), ListDataMembers(), ListFunctions(), TDocOutput::NameSpace2FileName(), TBaseClass::Property(), and TDocOutput::ReplaceSpecialChars().

void TClassDocOutput::Class2Html ( Bool_t  force = kFALSE  ) 

Definition at line 67 of file TClassDocOutput.cxx.

References TDocOutput::CopyHtmlFile(), TObject::Error(), fCurrentClass, TDocOutput::fHtml, fParser, THtml::GetCounter(), THtml::GetCounterFormat(), THtml::GetDeclFileName(), TROOT::GetListOfGlobals(), THtml::GetOutputDir(), TDocParser::GetSourceInfo(), gROOT, gSystem, TDocOutput::IsModified(), TDocOutput::kDoc, TDocParser::kInfoAuthor, TDocParser::kInfoCopyright, TDocParser::kInfoLastUpdate, TDocOutput::kSource, kTRUE, TDocOutput::NameSpace2FileName(), TDocParser::Parse(), TSystem::PrependPathName(), Printf(), WriteClassDocHeader(), TDocOutput::WriteHtmlFooter(), and TDocOutput::WriteHtmlHeader().

Bool_t TClassDocOutput::ClassDotCharts ( std::ostream &  out  ) 

Definition at line 387 of file TClassDocOutput.cxx.

References CreateDotClassChartIncl(), CreateDotClassChartInh(), CreateDotClassChartInhMem(), CreateDotClassChartLib(), dir(), fCurrentClass, TDocOutput::fHtml, THtml::GetOutputDir(), gSystem, THtml::HaveDot(), kFALSE, kTRUE, TSystem::MakeDirectory(), TDocOutput::NameSpace2FileName(), TSystem::PrependPathName(), TDocOutput::RunDot(), and title.

Referenced by WriteClassDescription().

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

Definition at line 1057 of file TClassDocOutput.cxx.

References DescendHierarchy(), fCurrentClass, fHierarchyLines, TClass::GetListOfBases(), TCollection::IsEmpty(), and TDocOutput::ReplaceSpecialChars().

Referenced by TDocOutput::CreateHierarchy().

void TClassDocOutput::MakeTree ( Bool_t  force = kFALSE  ) 

Definition at line 1282 of file TClassDocOutput.cxx.

References TString::BeginsWith(), ClassTree(), TVirtualPad::Close(), TObject::Error(), fCurrentClass, TDocOutput::fHtml, THtml::GetCounterFormat(), TDocOutput::GetHtml(), THtml::GetHtmlFileName(), gROOT, gSystem, THtml::HaveDot(), TSystem::IsAbsoluteFileName(), TROOT::IsBatch(), kFALSE, TString::Length(), Printf(), TROOT::ProcessLineFast(), R__LOCKGUARD, TString::Remove(), TROOT::SetBatch(), and what.

Referenced by THtml::MakeTree().

TClassDocOutput::ClassDef ( TClassDocOutput  ,
0   
)

void TClassDocOutput::ClassHtmlTree ( std::ostream &  out,
TClass *  classPtr,
ETraverse  dir = kBoth,
int  depth = 1 
) [protected]

void TClassDocOutput::ClassTree ( TVirtualPad *  canvas,
Bool_t  force = kFALSE 
) [protected]

Bool_t TClassDocOutput::CreateDotClassChartIncl ( const char *  filename  )  [protected]

Bool_t TClassDocOutput::CreateDotClassChartInh ( const char *  filename  )  [protected]

Bool_t TClassDocOutput::CreateDotClassChartInhMem ( const char *  filename  )  [protected]

Bool_t TClassDocOutput::CreateDotClassChartLib ( const char *  filename  )  [protected]

Bool_t TClassDocOutput::CreateHierarchyDot (  )  [protected]

void TClassDocOutput::CreateSourceOutputStream ( std::ostream &  out,
const char *  extension,
TString &  filename 
) [protected]

void TClassDocOutput::DescendHierarchy ( std::ostream &  out,
TClass *  basePtr,
Int_t  maxLines = 0,
Int_t  depth = 1 
) [protected]

virtual void TClassDocOutput::ListFunctions ( std::ostream &  classFile  )  [protected, virtual]

virtual void TClassDocOutput::ListDataMembers ( std::ostream &  classFile  )  [protected, virtual]

virtual void TClassDocOutput::WriteClassDocHeader ( std::ostream &  classFile  )  [protected, virtual]

virtual void TClassDocOutput::WriteMethod ( std::ostream &  out,
TString &  ret,
TString &  name,
TString &  params,
const char *  file,
TString &  anchor,
TString &  comment,
TString &  codeOneLiner,
TDocMethodWrapper *  guessedMethod 
) [protected, virtual]

virtual void TClassDocOutput::WriteClassDescription ( std::ostream &  out,
const TString &  description 
) [protected, virtual]

void TClassDocOutput::Class2Html ( Bool_t  force = kFALSE  ) 

Bool_t TClassDocOutput::ClassDotCharts ( std::ostream &  out  ) 

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

void TClassDocOutput::MakeTree ( Bool_t  force = kFALSE  ) 

TClassDocOutput::ClassDef ( TClassDocOutput  ,
0   
)

Friends And Related Function Documentation

TDocParser [friend]

Definition at line 66 of file TClassDocOutput.h.

Referenced by TClassDocOutput().

Member Data Documentation

Int_t TClassDocOutput::fHierarchyLines [protected]

Definition at line 28 of file TClassDocOutput.h.

Referenced by ClassHtmlTree(), CreateClassHierarchy(), and DescendHierarchy().

TClass* TClassDocOutput::fCurrentClass [protected]

Definition at line 29 of file TClassDocOutput.h.

Referenced by Class2Html(), ClassDotCharts(), ClassTree(), CreateClassHierarchy(), CreateDotClassChartIncl(), CreateDotClassChartInh(), CreateDotClassChartInhMem(), CreateDotClassChartLib(), CreateSourceOutputStream(), ListDataMembers(), ListFunctions(), MakeTree(), TClassDocOutput(), WriteClassDescription(), WriteClassDocHeader(), and WriteMethod().

TList* TClassDocOutput::fCurrentClassesTypedefs [protected]

Definition at line 30 of file TClassDocOutput.h.

Referenced by WriteClassDescription().

TDocParser* TClassDocOutput::fParser [protected]

Definition at line 31 of file TClassDocOutput.h.

Referenced by Class2Html(), ListDataMembers(), ListFunctions(), TClassDocOutput(), WriteClassDescription(), WriteMethod(), and ~TClassDocOutput().

TClass* TClassDocOutput::fCurrentClass [protected]

Definition at line 29 of file TClassDocOutput.h.

TList* TClassDocOutput::fCurrentClassesTypedefs [protected]

Definition at line 30 of file TClassDocOutput.h.

TDocParser* TClassDocOutput::fParser [protected]

Definition at line 31 of file TClassDocOutput.h.

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