A++ » INCLUDE » TDocParser

class TDocParser: public TObject


TDocParser

Parses documentation in source files

Function Members (Methods)

public:
virtual~TDocParser()
voidTObject::AbstractMethod(const char* method) const
static voidAnchorFromLine(const TString& line, TString& anchor)
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(ostream& out, istream& in, const char* relpath, Bool_t isCode, Bool_t interpretDirectives)
virtual voidTObject::Copy(TObject& object) const
virtual voidDecorateKeywords(TString& text)
virtual voidDecorateKeywords(ostream& out, const char* text)
voidDecrementMethodCount(const char* name)
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual voidDeleteDirectiveOutput() const
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
TClass*GetCurrentClass() const
voidGetCurrentModule(TString& out_module) const
const TList*GetDataMembers(TDocParser::EAccess access) const
TDocOutput*GetDocOutput() const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
const TList*GetEnums(TDocParser::EAccess access) const
virtual const char*TObject::GetIconName() const
Long_tGetLineNumber() const
const TList*GetMethods(TDocParser::EAccess access) 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
const char*GetSourceInfo(TDocParser::ESourceInfo type) const
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
UInt_tInContext(Int_t context) 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
static Bool_tIsName(UChar_t c)
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
static Bool_tIsWord(UChar_t c)
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
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)
TDocParser&operator=(const TDocParser&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidParse(ostream& out)
virtual voidTObject::Pop()
virtual voidTObject::Print(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
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)
voidSetCurrentModule(const char* module)
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)
static Bool_tStrip(TString& s)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
TDocParser(TDocOutput& docOutput)
TDocParser(const TDocParser&)
TDocParser(TClassDocOutput& docOutput, TClass* cl)
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
protected:
voidAddClassDataMembersRecursively(TBaseClass* bc)
voidAddClassMethodsRecursively(TBaseClass* bc)
TDocParser::EParseContextContext() const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
virtual voidExpandCPPLine(TString& line, Ssiz_t& pos)
virtual Bool_tHandleDirective(TString& keyword, Ssiz_t& pos, TString& word, Ssiz_t& copiedToCommentUpTo)
virtual voidInitKeywords() const
virtual TClass*IsDirective(const TString& line, Ssiz_t pos, const TString& word, Bool_t& begin) const
TMethod*LocateMethodInCurrentLine(Ssiz_t& posMethodName, TString& ret, TString& name, TString& params, Bool_t& isconst, ostream& srcOut, TString& anchor, ifstream& sourcefile, Bool_t allowPureVirtual)
voidLocateMethods(ostream& out, const char* filename, Bool_t lookForSourceInfo = kTRUE, Bool_t useDocxxStyle = kFALSE, Bool_t allowPureVirtual = kFALSE, const char* methodPattern = 0, const char* sourceExt = 0)
voidLocateMethodsInHeaderClassDecl(ostream& out)
voidLocateMethodsInHeaderInline(ostream& out)
voidLocateMethodsInSource(ostream& out)
voidTObject::MakeZombie()
virtual Bool_tProcessComment()
voidRemoveCommentContext(Bool_t cxxcomment)
voidWriteClassDoc(ostream& out, Bool_t first = kTRUE)
voidWriteMethod(ostream& out, TString& ret, TString& name, TString& params, Bool_t isconst, const char* file, TString& anchor, TString& codeOneLiner)
voidWriteSourceLine(ostream& out)

Data Members

public:
static TObject::(anonymous)TObject::kBitMask
static TDocParser::EParseContextkCPP
static TDocParser::EParseContextFlagkCXXComment
static TObject::EStatusBitsTObject::kCanDelete
static TObject::EStatusBitsTObject::kCannotPick
static TDocParser::EParseContextkCode
static TDocParser::EParseContextkComment
static TDocParser::EParseContextkDirective
static TObject::EStatusBitsTObject::kHasUUID
static TDocParser::ESourceInfokInfoAuthor
static TDocParser::ESourceInfokInfoCopyright
static TDocParser::ESourceInfokInfoLastChanged
static TDocParser::ESourceInfokInfoLastGenerated
static TDocParser::ESourceInfokInfoLastUpdate
static TObject::EStatusBitsTObject::kInvalidObject
static TObject::(anonymous)TObject::kIsOnHeap
static TObject::EStatusBitsTObject::kIsReferenced
static TDocParser::EParseContextkKeyword
static TObject::EStatusBitsTObject::kMustCleanup
static TDocParser::EParseContextkNoContext
static TObject::EStatusBitsTObject::kNoContextMenu
static TObject::(anonymous)TObject::kNotDeleted
static TDocParser::EParseContextkNumParseContexts
static TDocParser::ESourceInfokNumSourceInfos
static TObject::EStatusBitsTObject::kObjInCanvas
static TObject::(anonymous)TObject::kOverwrite
static TDocParser::EParseContextFlagkParseContextFlagMask
static TDocParser::EParseContextkParseContextMask
static TDocParser::EAccesskPrivate
static TDocParser::EAccesskProtected
static TDocParser::EAccesskPublic
static TObject::(anonymous)TObject::kSingleKey
static TDocParser::EParseContextkString
static TDocParser::EParseContextkVerbatim
static TObject::(anonymous)TObject::kWriteDelete
static TObject::(anonymous)TObject::kZombie
protected:
Bool_tfAllowDirectiveswhether directives are to be interpreted
Bool_tfCheckForMethodwhether to check the current line for a method
TStringfClassDescrTagtag for finding the class description
enum(anonymous)fClassDocStatewhether we found the class description
TStringfCommentcurrent comment
Bool_tfCommentAtBOLat the beginning of the current line, fParseContext contained kComment
TClass*fCurrentClasscurrent class context of sources being parsed
TStringfCurrentFilecurrent source / header file name
TStringfCurrentMethodTagname_idx of the currently parsed method
TStringfCurrentModulecurrent module context of sources being parsed
TListfDataMembers[6]data members (by access, plus enums)
Int_tfDirectiveCountindex of directive for current method
TListfDirectiveHandlershandler for doc directives (TDocDirective objects)
TDocParser::EDocContextfDocContextcurrent context of parsed sources for documenting
TDocOutput*fDocOutputTDocOutput invoking us
set<UInt_t>fExtraLinesWithAnchorlines that need an additional anchor
TStringfFirstClassDocfirst class-doc found - per file, taken if fLastClassDoc is empty
THtml*fHtmlTHtml object using us
TStringfLastClassDoclast class-doc found - becomes class doc at ClassImp or first method
TStringfLineCommentcurrent line with links and directives for doc
UInt_tfLineNocurrent line number
Long_tfLineNumbersource line number
TStringfLineRawcurrent line
TStringfLineSourcecurrent line with links
TStringfLineStrippedcurrent line without surrounding spaces
map<string,Int_t>fMethodCountsnumber of undocumented overloads
THashListfMethods[3]methods as TMethodWrapper objects (by access)
list<UInt_t>fParseContextcurrent context of parsed sources
TClass*fRecentClassrecently seen class context of sources being parsed, e.g. for Convert()
TStringfSourceInfo[5]author, last changed, ...
TStringfSourceInfoTags[5]tags for source info elements (copyright, last changed, author)
static set<string>fgKeywordsC++ keywords
static TDocParser::(anonymous)kClassDoc_Ignore
static TDocParser::(anonymous)kClassDoc_LookingHaveSomething
static TDocParser::(anonymous)kClassDoc_LookingNothingFound
static TDocParser::(anonymous)kClassDoc_NumStates
static TDocParser::(anonymous)kClassDoc_Uninitialized
static TDocParser::(anonymous)kClassDoc_Written
static TDocParser::EDocContextkDocClass
static TDocParser::EDocContextkDocFunc
static TDocParser::EDocContextkIgnore
static TDocParser::EDocContextkNumDocContexts

Class Charts

Inheritance Chart:
TObject
←
TDocParser

Function documentation

TClass* fRecentClass; // recently seen class context of sources being parsed, e.g. for Convert()
void AddClassMethodsRecursively(TBaseClass* bc)
void AddClassDataMembersRecursively(TBaseClass* bc)
void ExpandCPPLine(TString& line, Ssiz_t& pos)
Bool_t HandleDirective(TString& keyword, Ssiz_t& pos, TString& word, Ssiz_t& copiedToCommentUpTo)
TClass* IsDirective(const TString& line, Ssiz_t pos, const TString& word, Bool_t& begin) const
TMethod* LocateMethodInCurrentLine(Ssiz_t& posMethodName, TString& ret, TString& name, TString& params, Bool_t& isconst, ostream& srcOut, TString& anchor, ifstream& sourcefile, Bool_t allowPureVirtual)
void LocateMethodsInHeaderInline(ostream& out)
void LocateMethodsInHeaderClassDecl(ostream& out)
void LocateMethods(ostream& out, const char* filename, Bool_t lookForSourceInfo = kTRUE, Bool_t useDocxxStyle = kFALSE, Bool_t allowPureVirtual = kFALSE, const char* methodPattern = 0, const char* sourceExt = 0)
void RemoveCommentContext(Bool_t cxxcomment)
void WriteClassDoc(ostream& out, Bool_t first = kTRUE)
void WriteMethod(ostream& out, TString& ret, TString& name, TString& params, Bool_t isconst, const char* file, TString& anchor, TString& codeOneLiner)
TDocParser(TClassDocOutput& docOutput, TClass* cl)
TDocParser(TDocOutput& docOutput)
virtual ~TDocParser()
void AnchorFromLine(const TString& line, TString& anchor)
void DecrementMethodCount(const char* name)
void DecorateKeywords(ostream& out, const char* text)
void DecorateKeywords(TString& text)
void DeleteDirectiveOutput() const
const TList* GetMethods(TDocParser::EAccess access) const
{ return &fMethods[access]; }
TClass* GetCurrentClass() const
{ return fCurrentClass; }
void GetCurrentModule(TString& out_module) const
TDocOutput* GetDocOutput() const
{ return fDocOutput; }
Long_t GetLineNumber() const
{ return fLineNumber; }
const TList* GetDataMembers(TDocParser::EAccess access) const
{ return &fDataMembers[access]; }
const TList* GetEnums(TDocParser::EAccess access) const
{ return &fDataMembers[access+3]; }
const char* GetSourceInfo(TDocParser::ESourceInfo type) const
{ return fSourceInfo[type]; }
void SetCurrentModule(const char* module)
{ fCurrentModule = module; }
UInt_t InContext(Int_t context) const
Bool_t IsName(UChar_t c)
Bool_t IsWord(UChar_t c)
void Parse(ostream& out)
Bool_t Strip(TString& s)