Definition at line 22 of file TClassDocOutput.h.

Public Member Functions
	TClassDocOutput (THtml &html, TClass cl, TList typedefs)
	Create an object given the invoking THtml object, and the TClass object that we will generate output for. More...

virtual	~TClassDocOutput ()
	Destructor, deletes fParser. More...

void	Class2Html (Bool_t force=kFALSE)
	Create HTML files for a single class. More...

Bool_t	ClassDotCharts (std::ostream &out)
	This function builds the class charts for one class in GraphViz/Dot format, i.e. More...

void	CreateClassHierarchy (std::ostream &out, const char *docFileName)
	Create the hierarchical class list part for the current class's base classes. More...

void	MakeTree (Bool_t force=kFALSE)
	Create an output file with a graphical representation of the class inheritance. More...

Public Member Functions inherited from TDocOutput
	TDocOutput (THtml &html)

virtual	~TDocOutput ()

virtual void	AdjustSourcePath (TString &line, const char *relpath="../")
	adjust the path of links for source files, which are in src/, but need to point to relpath (usually "../"). More...

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)
	Convert a text file into a html file. More...

Bool_t	CopyHtmlFile (const char sourceName, const char destName="")
	Copy file to HTML directory. More...

virtual void	CreateClassIndex ()
	Create index of all classes. More...

virtual void	CreateClassTypeDefs ()
	Create a forwarding page for each typedef pointing to a class. More...

virtual void	CreateHierarchy ()
	Create a hierarchical class list The algorithm descends from the base classes and branches into all derived classes. More...

virtual void	CreateModuleIndex ()
	Create the class index for each module, picking up documentation from the module's TModuleDocInfo::GetInputPath() plus the (possibly relative) THtml::GetModuleDocPath(). More...

virtual void	CreateProductIndex ()
	Fetch documentation from THtml::GetProductDocDir() and put it into the product index page. More...

virtual void	CreateTypeIndex ()
	Create index of all data types. More...

virtual void	DecorateEntityBegin (TString &str, Ssiz_t &pos, TDocParser::EParseContext type)
	Add some colors etc to a source entity, contained in str. More...

virtual void	DecorateEntityEnd (TString &str, Ssiz_t &pos, TDocParser::EParseContext type)
	Add some colors etc to a source entity, contained in str. More...

virtual void	FixupAuthorSourceInfo (TString &authors)
	Special author treatment; called when TDocParser::fSourceInfo[kInfoAuthor] is set. More...

const char *	GetExtension () const

THtml *	GetHtml ()

virtual Bool_t	IsModified (TClass *classPtr, EFileType type)
	Check if file is modified. More...

virtual void	NameSpace2FileName (TString &name)
	Replace "::" in name by "__" Replace "<", ">", " ", ",", "~", "=" in name by "_" Replace "A::X<A::Y>" by "A::X<-p0Y>", "A::B::X<A::B::Y>" by "A::B::X<-p1Y>", etc. More...

virtual void	ReferenceEntity (TSubString &str, TClass entity, const char comment=0)
	Create a reference to a class documentation page. More...

virtual void	ReferenceEntity (TSubString &str, TDataMember entity, const char comment=0)
	Create a reference to a data member documentation page. More...

virtual void	ReferenceEntity (TSubString &str, TDataType entity, const char comment=0)
	Create a reference to a type documentation page. More...

virtual void	ReferenceEntity (TSubString &str, TMethod entity, const char comment=0)
	Create a reference to a method documentation page. More...

virtual Bool_t	ReferenceIsRelative (const char *reference) const
	Check whether reference is a relative reference, and can (or should) be prependen by relative paths. More...

virtual const char *	ReplaceSpecialChars (char c)
	Replace ampersand, less-than and greater-than character, writing to out. More...

void	ReplaceSpecialChars (std::ostream &out, const char *string)
	Replace ampersand, less-than and greater-than characters, writing to out. More...

void	ReplaceSpecialChars (TString &text)
	Replace ampersand, less-than and greater-than character. More...

void	ReplaceSpecialChars (TString &text, Ssiz_t &pos)
	Replace ampersand, less-than and greater-than character. More...

virtual void	WriteHtmlFooter (std::ostream &out, const char dir="", const char lastUpdate="", const char author="", const char copyright="")
	Write HTML footer. More...

virtual void	WriteHtmlHeader (std::ostream &out, const char title, const char dir="", TClass *cls=0)
	Write HTML header. More...

void	WriteLineNumbers (std::ostream &out, Long_t nLines, const TString &infileBase) const
	Create a div containing the line numbers (for a source listing) 1 to nLines. More...

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...

	TObject (const TObject &object)
	TObject copy ctor. More...

virtual	~TObject ()
	TObject destructor. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method. More...

virtual void	Copy (TObject &object) const
	Copy this to obj. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout. More...

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

void	SetBit (UInt_t f)

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

Protected Types
enum	ETraverse { kUp, kDown, kBoth }

Protected Types inherited from TDocOutput
enum	EGraphvizTool { kDot, kNeato, kFdp, kCirco }

Protected Member Functions
void	ClassHtmlTree (std::ostream &out, TClass *classPtr, ETraverse dir=kBoth, int depth=1)
	This function builds the class tree for one class in HTML (inherited and succeeding classes, called recursively) More...

void	ClassTree (TVirtualPad *canvas, Bool_t force=kFALSE)
	It makes a graphical class tree. More...

Bool_t	CreateDotClassChartIncl (const char *filename)
	Build the include dependency graph for one class in GraphViz/Dot format. More...

Bool_t	CreateDotClassChartInh (const char *filename)
	Build the class tree for one class in GraphViz/Dot format. More...

Bool_t	CreateDotClassChartInhMem (const char *filename)
	Build the class tree of inherited members for one class in GraphViz/Dot format. More...

Bool_t	CreateDotClassChartLib (const char *filename)
	Build the library dependency graph for one class in GraphViz/Dot format. More...

Bool_t	CreateHierarchyDot ()
	Create a hierarchical class list The algorithm descends from the base classes and branches into all derived classes. More...

void	CreateSourceOutputStream (std::ostream &out, const char *extension, TString &filename)
	Open a Class.cxx.html file, where Class is defined by classPtr, and .cxx.html by extension It's created in fHtml->GetOutputDir()/src. More...

void	DescendHierarchy (std::ostream &out, TClass *basePtr, Int_t maxLines=0, Int_t depth=1)
	Descend hierarchy recursively loop over all classes and look for classes with base class basePtr. More...

virtual void	ListDataMembers (std::ostream &classFile)
	Write the list of data members and enums. More...

virtual void	ListFunctions (std::ostream &classFile)
	Write the list of functions. More...

virtual void	WriteClassDescription (std::ostream &out, const TString &description)
	Called by TDocParser::LocateMethods(), this hook writes out the class description found by TDocParser. More...

virtual void	WriteClassDocHeader (std::ostream &classFile)
	Write out the introduction of a class description (shortcuts and links) More...

virtual void	WriteMethod (std::ostream &out, TString &ret, TString &name, TString &params, const char file, TString &anchor, TString &comment, TString &codeOneLiner, TDocMethodWrapper guessedMethod)
	Write method name with return type ret and parameters param to out. More...

Protected Member Functions inherited from TDocOutput
void	AddLink (TSubString &str, TString &link, const char *comment)
	Add a link around str, with title comment. More...

int	CaseInsensitiveSort (const void name1, const void name2)

void	ProcessDocInDir (std::ostream &out, const char indir, const char outdir, const char *linkdir)
	Write links to files indir/.txt, indir/.html (non-recursive) to out. More...

Bool_t	RunDot (const char filename, std::ostream outMap=0, EGraphvizTool gvwhat=kDot)
	Run filename".dot", creating filename".png", and - if outMap is !=0, filename".map", which gets then included literally into outMap. More...

void	WriteHtmlFooter (std::ostream &out, const char dir, const char lastUpdate, const char author, const char copyright, const char *footer)
	Write HTML footer. More...

void	WriteHtmlHeader (std::ostream &out, const char titleNoSpecial, const char dir, TClass cls, const char header)
	Write HTML header. More...

void	WriteLocation (std::ostream &out, TModuleDocInfo module, const char classname=0)
	make a link to the description More...

void	WriteModuleLinks (std::ostream &out)
	Create a div containing links to all topmost modules. More...

void	WriteModuleLinks (std::ostream &out, TModuleDocInfo *super)
	Create a div containing links to all modules. More...

virtual void	WriteSearch (std::ostream &out)
	Write a search link or a search box, based on THtml::GetSearchStemURL() and THtml::GetSearchEngine(). More...

void	WriteTopLinks (std::ostream &out, TModuleDocInfo module, const char classname=0, Bool_t withLocation=kTRUE)
	Write the first part of the links shown ontop of each doc page; one <div> has to be closed by caller so additional items can still be added. More...

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

void	MakeZombie ()

Protected Attributes
TClass *	fCurrentClass

TList *	fCurrentClassesTypedefs

Int_t	fHierarchyLines

TDocParser *	fParser

Protected Attributes inherited from TDocOutput
THtml *	fHtml

Friends
class	TDocParser

Additional Inherited Members
Public Types inherited from TDocOutput
enum	EFileType { kSource, kInclude, kTree, kDoc }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }

enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

#include <TClassDocOutput.h>

Inheritance diagram for TClassDocOutput:

[legend]

Member Enumeration Documentation

enum TClassDocOutput::ETraverse

protected

Enumerator
kUp
kDown
kBoth

Definition at line 24 of file TClassDocOutput.h.

Constructor & Destructor Documentation

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

Create an object given the invoking THtml object, and the TClass object that we will generate output for.

Definition at line 52 of file TClassDocOutput.cxx.

TClassDocOutput::~TClassDocOutput ( )

virtual

Destructor, deletes fParser.

Definition at line 62 of file TClassDocOutput.cxx.

Member Function Documentation

void TClassDocOutput::Class2Html ( Bool_t force = kFALSE )

Create HTML files for a single class.

Definition at line 71 of file TClassDocOutput.cxx.

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

This function builds the class charts for one class in GraphViz/Dot format, i.e.

the inheritance diagram, the include dependencies, and the library dependency.

Input: out - output file stream

Definition at line 394 of file TClassDocOutput.cxx.

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

protected

This function builds the class tree for one class in HTML (inherited and succeeding classes, called recursively)

Input: out - output file stream classPtr - pointer to the class dir - direction to traverse tree: up, down or both

Definition at line 468 of file TClassDocOutput.cxx.

void TClassDocOutput::ClassTree	(	TVirtualPad *	psCanvas,
		Bool_t	force = `kFALSE`
	)

protected

It makes a graphical class tree.

Input: psCanvas - pointer to the current canvas classPtr - pointer to the class

Definition at line 588 of file TClassDocOutput.cxx.

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

Create the hierarchical class list part for the current class's base classes.

docFileName contains doc for fCurrentClass.

Definition at line 1062 of file TClassDocOutput.cxx.

Bool_t TClassDocOutput::CreateDotClassChartIncl ( const char * filename )

protected

Build the include dependency graph for one class in GraphViz/Dot format.

Input: filename - output dot file incl. path

Definition at line 909 of file TClassDocOutput.cxx.

Bool_t TClassDocOutput::CreateDotClassChartInh ( const char * filename )

protected

Build the class tree for one class in GraphViz/Dot format.

Input: filename - output dot file incl. path

Definition at line 619 of file TClassDocOutput.cxx.

Bool_t TClassDocOutput::CreateDotClassChartInhMem ( const char * filename )

protected

Build the class tree of inherited members for one class in GraphViz/Dot format.

Input: filename - output dot file incl. path

Definition at line 727 of file TClassDocOutput.cxx.

Bool_t TClassDocOutput::CreateDotClassChartLib ( const char * filename )

protected

Build the library dependency graph for one class in GraphViz/Dot format.

Input: filename - output dot file incl. path

Definition at line 993 of file TClassDocOutput.cxx.

Bool_t TClassDocOutput::CreateHierarchyDot ( )

protected

Create a hierarchical class list The algorithm descends from the base classes and branches into all derived classes.

Mixing classes are displayed several times.

Definition at line 1096 of file TClassDocOutput.cxx.

void TClassDocOutput::CreateSourceOutputStream	(	std::ostream &	out,
		const char *	extension,
		TString &	sourceHtmlFileName
	)

protected

Open a Class.cxx.html file, where Class is defined by classPtr, and .cxx.html by extension It's created in fHtml->GetOutputDir()/src.

If successful, the HTML header is written to out.

Definition at line 1176 of file TClassDocOutput.cxx.

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

protected

Descend hierarchy recursively loop over all classes and look for classes with base class basePtr.

Definition at line 1211 of file TClassDocOutput.cxx.

void TClassDocOutput::ListDataMembers ( std::ostream & classFile )

protectedvirtual

Write the list of data members and enums.

Definition at line 246 of file TClassDocOutput.cxx.

void TClassDocOutput::ListFunctions ( std::ostream & classFile )

protectedvirtual

Write the list of functions.

Definition at line 121 of file TClassDocOutput.cxx.

void TClassDocOutput::MakeTree ( Bool_t force = kFALSE )

Create an output file with a graphical representation of the class inheritance.

If force, replace existing output file. This routine does nothing if fHtml->HaveDot() is true - use ClassDotCharts() instead!

Definition at line 1288 of file TClassDocOutput.cxx.

void TClassDocOutput::WriteClassDescription	(	std::ostream &	out,
		const TString &	description
	)

protectedvirtual

Called by TDocParser::LocateMethods(), this hook writes out the class description found by TDocParser.

It's even called if none is found, i.e. if the first method has occurred before a class description is found, so missing class descriptions can be handled. For HTML, its creates the description block, the list of functions and data members, and the inheritance tree or, if Graphviz's dot is found, the class charts.

Definition at line 1341 of file TClassDocOutput.cxx.

void TClassDocOutput::WriteClassDocHeader ( std::ostream & classFile )

protectedvirtual

Write out the introduction of a class description (shortcuts and links)

Definition at line 1432 of file TClassDocOutput.cxx.

void TClassDocOutput::WriteMethod	(	std::ostream &	out,
		TString &	ret,
		TString &	name,
		TString &	params,
		const char *	filename,
		TString &	anchor,
		TString &	comment,
		TString &	codeOneLiner,
		TDocMethodWrapper *	guessedMethod
	)

protectedvirtual

Write method name with return type ret and parameters param to out.

Build a link using file and anchor. Cooment it with comment, and show the code codeOneLiner (set if the func consists of only one line of code, immediately surrounded by "{","}"). Also updates fMethodNames's count of method names.

Definition at line 1592 of file TClassDocOutput.cxx.

Friends And Related Function Documentation

friend class TDocParser

friend

Definition at line 66 of file TClassDocOutput.h.

Member Data Documentation

TClass* TClassDocOutput::fCurrentClass

protected

Definition at line 29 of file TClassDocOutput.h.

TList* TClassDocOutput::fCurrentClassesTypedefs

protected

Definition at line 30 of file TClassDocOutput.h.

Int_t TClassDocOutput::fHierarchyLines

protected

Definition at line 28 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:

html/inc/TClassDocOutput.h
html/src/TClassDocOutput.cxx

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation