Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file viewVC header viewVC source

Sections: class description function members data members class charts

class TDocDirective: public TNamed


 When THtml parses documentation (through TDocParser), it checks for special
 words ("begin_something", "end_something", where the begin and end are the
 significant part). THtml then searches for a TDocDirective which can handle
 these tags ("whatever" in the example), passes the text enclosed by these
 tags to the directive, which in turn processes it.

 That way, HTML, latex, and C++ macros can be processed by THtml, e.g. to
 generate plain HTML or GIF pictures. The classes reposinsible for parsing
 that are TDocHtmlDirective, TDocLatexDirective, and TDocMacroDirective,
 respecively.

 Directives can have optional parameters; these are passed as paranthesis
 enclosed, comma delimited name=value pairs; see SetParameters().

 You can implement your own directive simply by deriving from TDocDirective;
the tag corresponds to TDocDirective's name (e.g. "HTML" for "begin_html"
 "end_html").

Function Members (Methods)

This is an abstract class, constructors will not be documented.
Look at the header to check for available constructors.

public:

void	TObject::AbstractMethod(const char* method) const
virtual void	AddLine(const TSubString& line)
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual void	TNamed::Copy(TObject& named) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual void	DeleteOutput() const
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 void	TNamed::FillBuffer(char*& buffer)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	GetEndTag() const
virtual const char*	TObject::GetIconName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
virtual Bool_t	GetResult(TString& result)
virtual const char*	TNamed::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TNamed::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
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TNamed::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
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)
TDocDirective&	operator=(const TDocDirective&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TNamed::Print(Option_t* option = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
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)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
static void	TObject::SetObjectStat(Bool_t stat)
virtual void	TNamed::SetTitle(const char* title = "")MENU
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual Int_t	TNamed::Sizeof() const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
	TDocDirective(const TDocDirective&)
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

protected:

virtual	~TDocDirective()
virtual void	AddParameter(const TString&, const char* = 0)
virtual void	DeleteOutputFiles(const char* ext) const
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
TDocOutput*	GetDocOutput() const
TDocParser*	GetDocParser() const
THtml*	GetHtml() const
virtual const char*	GetName() const
void	GetName(TString& name) const
const char*	GetOutputDir() const
void	TObject::MakeZombie()
void	SetCounter(Int_t count)
void	SetParameters(const char* params)
void	SetParser(TDocParser* parser)
void	SetTag(const char* tag)
	TDocDirective()
	TDocDirective(const char* name)

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TObject::EStatusBits	TObject::kHasUUID
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 TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

Int_t	fCounter	counter to generate unique names, -1 to ignore
TDocOutput*	fDocOutput	parser invoking this handler
TDocParser*	fDocParser	parser invoking this handler
THtml*	fHtml	parser's THtml object
TString	TNamed::fName	object identifier
TString	fParameters	parameters to the directive
TString	TNamed::fTitle	object title

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

void DeleteOutputFiles(const char* ext) const

 Delete all output generated by the directive beginning
 with Name() and ending with ext

void GetName(TString& name) const

 Get the full name, based on fName, fTitle, fDocParser's tag.

const char* GetOutputDir() const

 Get the directory for documentation output.

void SetParameters(const char* params)

 Given a string containing parameters in params,
 we call AddParameter() for each of them.
 This function splits the parameter names and
 extracts their values if they are given.
 Parameters are separated by ",", values are
 separated from parameter names by "=".
 params being
    a = "a, b, c", b='d,e'
 will issue two calls to AddParameter(), one for
 a with value "a, b, c" and one for b with value
 "d,e" (each without the quotation marks).

void SetParser(TDocParser* parser)

 Set the parser, and fDocOutput, fHtml from that

void AddParameter(const TString& , const char* = 0)

{}

TDocDirective()

{}

TDocDirective(const char* name)

{}

virtual ~TDocDirective()

{}

const char* GetName() const

{ return TNamed::GetName(); }

TDocParser* GetDocParser() const

{ return fDocParser; }

TDocOutput* GetDocOutput() const

{ return fDocOutput; }

THtml* GetHtml() const

{ return fHtml; }

void SetTag(const char* tag)

{ SetTitle(tag); }

void SetCounter(Int_t count)

{ fCounter = count; }

const char* GetEndTag() const

 get the tag ending this directive

void AddLine(const TSubString& line)

 add a line to the directive's text

Bool_t GetResult(TString& result)

 retrieve the result (replacement) of the directive; return false if invalid

void DeleteOutput() const

 Delete output for the parser's current class or module.

{}

TDocDirective(const TDocDirective& )

{}