Definition at line 40 of file THtml.h.

Classes
struct	DocEntityInfo_t

struct	DocSyntax_t

struct	LinkInfo_t

struct	OutputStyle_t

struct	PathInfo_t

class	TFileDefinition

class	TFileSysDB

class	TFileSysDir

class	TFileSysEntry

class	TFileSysRoot

class	THelperBase

class	TModuleDefinition

class	TPathDefinition

Public Types
enum	EConvertOutput { kNoOutput , kInterpretedOutput , kCompiledOutput , kForceOutput = 0x10 , kSeparateProcessOutput = 0x20 }

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

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

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

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

Public Member Functions
	THtml ()
	Create a THtml object. More...

virtual	~THtml ()
	Default destructor. More...

void	AddMacroPath (const char *path)
	Add path to the directories to be searched for macro files that are to be executed via the TDocMacroDirective ("Begin_Macro"/"End_Macro"); relative to the source file that the directive is run on. More...

void	Convert (const char filename, const char title, const char dirname="", const char relpath="../", Int_t includeOutput=kNoOutput, const char *context="")
	It converts a single text file to HTML. More...

Bool_t	CopyFileFromEtcDir (const char *filename) const
	Copy a file from $ROOTSYS/etc/html into GetOutputDir() More...

virtual void	CreateAuxiliaryFiles () const
	copy CSS, javascript file, etc to the output dir More...

void	CreateHierarchy ()
	Create the inheritance hierarchy diagram for all classes. More...

const TString &	GetAuthorTag () const

const TString &	GetCharset () const

virtual TClass *	GetClass (const char *name) const
	Return pointer to class with name. More...

const TString &	GetClassDocTag () const

const TString &	GetCopyrightTag () const

const char *	GetCounter () const

const char *	GetCounterFormat () const

virtual bool	GetDeclFileName (TClass *cl, Bool_t filesys, TString &out_name) const
	Return declaration file name; return the full path if filesys is true. More...

void	GetDerivedClasses (TClass cl, std::map< TClass , Int_t > &derived) const
	fill derived with all classes inheriting from cl and their inheritance distance to cl More...

const TString &	GetDocStyle () const

const TString &	GetDotDir () const

virtual const char *	GetEtcDir () const
	Get the directory containing THtml's auxiliary files ($ROOTSYS/etc/html) More...

const TFileDefinition &	GetFileDefinition () const
	Return the TFileDefinition (or derived) object as set by SetFileDefinition(); create and return a TFileDefinition object if none was set. More...

const TString &	GetFooter () const

const TString &	GetHeader () const

const TString &	GetHomepage () const

virtual const char *	GetHtmlFileName (const char *classname) const
	Get the html file name for a class named classname. More...

virtual void	GetHtmlFileName (TClass *classPtr, TString &filename) const
	Return real HTML filename. More...

virtual bool	GetImplFileName (TClass *cl, Bool_t filesys, TString &out_name) const
	Return implementation file name. More...

const TString &	GetInputPath () const

const TString &	GetLastUpdateTag () const

TList *	GetLibraryDependencies ()

const TList *	GetListOfClasses () const

const TList *	GetListOfModules () const

TFileSysDB *	GetLocalFiles () const

const TString &	GetMacroPath () const

TVirtualMutex *	GetMakeClassMutex () const

const TModuleDefinition &	GetModuleDefinition () const
	Return the TModuleDefinition (or derived) object as set by SetModuleDefinition(); create and return a TModuleDefinition object if none was set. More...

const TString &	GetModuleDocPath () const

void	GetModuleMacroPath (const TString &module, TString &out_path) const

virtual void	GetModuleNameForClass (TString &module, TClass *cl) const
	Return the module name for a given class. More...

const TString &	GetOutputDir (Bool_t createDir=kTRUE) const
	Return the output directory as set by SetOutputDir(). More...

const TPathDefinition &	GetPathDefinition () const
	Return the TModuleDefinition (or derived) object as set by SetModuleDefinition(); create and return a TModuleDefinition object if none was set. More...

const PathInfo_t &	GetPathInfo () const

const TString &	GetProductName () const

const TString &	GetSearchEngine () const

const TString &	GetSearchStemURL () const

const char *	GetURL (const char *lib=0) const
	Get the documentation URL for library lib. More...

const TString &	GetViewCVS () const

const TString &	GetWikiURL () const

const TString &	GetXwho () const

Bool_t	HaveDot ()
	Check whether dot is available in $PATH or in the directory set by SetDotPath() More...

void	HelperDeleted (THelperBase *who)
	Inform the THtml object that one of its helper objects was deleted. More...

Bool_t	IsBatch () const

void	MakeAll (Bool_t force=kFALSE, const char filter="", int numthreads=1)
	Produce documentation for all the classes specified in the filter (by default "") To process all classes having a name starting with XX, do: html.MakeAll(kFALSE,"XX"); If force=kFALSE (default), only the classes that have been modified since the previous call to this function will be generated. More...

void	MakeClass (const char *className, Bool_t force=kFALSE)
	Make HTML files for a single class. More...

void	MakeIndex (const char filter="")
	Create the index files for the product, modules, all types, etc. More...

void	MakeTree (const char *className, Bool_t force=kFALSE)
	Make an inheritance tree. More...

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

void	SetAuthorTag (const char *tag)

void	SetBatch (Bool_t batch=kTRUE)

void	SetCharset (const char *charset)

void	SetClassDocTag (const char *tag)

void	SetCopyrightTag (const char *tag)

void	SetCounterFormat (const char *format)

void	SetDeclFileName (TClass cl, const char filename)
	Explicitly set a decl file name for TClass cl. More...

void	SetDocPath (const char *path)

void	SetDocStyle (const char *style)

void	SetDotDir (const char *dir)

void	SetEscape (char='\\')

void	SetEtcDir (const char *dir)

void	SetFileDefinition (const TFileDefinition &fd)
	Set the file defining object to be used; can also be a user derived object (a la traits). More...

void	SetFooter (const char *file)

void	SetFoundDot (Bool_t found=kTRUE)
	Set whether "dot" (a GraphViz utility) is available. More...

void	SetHeader (const char *file)

void	SetHomepage (const char *url)

void	SetImplFileName (TClass cl, const char filename)
	Explicitly set a impl file name for TClass cl. More...

void	SetIncludePath (const char *dir)

void	SetInputDir (const char *dir)
	Set the directory containing the source files. More...

void	SetLastUpdateTag (const char *tag)

void	SetLibURL (const char lib, const char url)

void	SetMacroPath (const char *path)

void	SetModuleDefinition (const TModuleDefinition &md)
	Set the module defining object to be used; can also be a user derived object (a la traits). More...

void	SetOutputDir (const char *dir)
	Set the directory where the HTML pages shuold be written to. More...

void	SetPathDefinition (const TPathDefinition &pd)
	Set the path defining object to be used; can also be a user derived object (a la traits). More...

void	SetProductName (const char *product)

void	SetRootURL (const char *url)

void	SetSearchEngine (const char *url)

void	SetSearchStemURL (const char *url)

void	SetSourceDir (const char *dir)

void	SetViewCVS (const char *url)

void	SetWikiURL (const char *url)

void	SetXwho (const char *xwho)

const char *	ShortType (const char *name) const
	Get short type name, i.e. with default templates removed. More...

void	SortListOfModules ()

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...

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. 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 selected pad for instance with: `gROOT->SetSelectedPad(gPad)`. 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...

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. 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...

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE 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)

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

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...

R__ALWAYS_INLINE 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...

Static Public Member Functions
static const char *	GetDirDelimiter ()

static Bool_t	IsNamespace (const TClass *cl)
	Check whether cl is a namespace. More...

static void	LoadAllLibs ()
	Load all libraries known to ROOT via the rootmap system. More...

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...

Protected Member Functions
virtual void	CreateJavascript () const
	Write the default ROOT style sheet. More...

void	CreateListOfClasses (const char *filter)
	Create the list of all known classes. More...

void	CreateListOfTypes ()
	Create index of all data types and a page for each typedef-to-class. More...

virtual void	CreateStyleSheet () const
	Write the default ROOT style sheet. More...

virtual bool	GetDeclImplFileName (TClass *cl, bool filesys, bool decl, TString &out_name) const
	Combined implementation for GetDeclFileName(), GetImplFileName(): Return declaration / implementation file name (depending on decl); return the full path if filesys is true. More...

TClassDocInfo *	GetNextClass ()
	Return the next class to be generated for MakeClassThreaded. More...

void	MakeClass (void *cdi, Bool_t force=kFALSE)
	Make HTML files for a single class. More...

void	SetLocalFiles () const
	Fill the files available in the file system below fPathInfo.fInputPath. 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 ()

Static Protected Member Functions
static void *	MakeClassThreaded (void *info)
	Entry point of worker threads for multi-threaded MakeAll(). More...

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <THtml.h>

Inheritance diagram for THtml:

[legend]

Member Enumeration Documentation

◆ EConvertOutput

enum THtml::EConvertOutput

Enumerator
kNoOutput
kInterpretedOutput
kCompiledOutput
kForceOutput
kSeparateProcessOutput

Definition at line 233 of file THtml.h.

Constructor & Destructor Documentation

◆ THtml()

THtml::THtml ( )

Create a THtml object.

In case output directory does not exist an error will be printed and gHtml stays 0 also zombie bit will be set.

Definition at line 1214 of file THtml.cxx.

◆ ~THtml()

THtml::~THtml ( )

virtual

Default destructor.

Definition at line 1256 of file THtml.cxx.

Member Function Documentation

◆ AddMacroPath()

void THtml::AddMacroPath ( const char * path )

Add path to the directories to be searched for macro files that are to be executed via the TDocMacroDirective ("Begin_Macro"/"End_Macro"); relative to the source file that the directive is run on.

Definition at line 1276 of file THtml.cxx.

◆ Convert()

void THtml::Convert	(	const char *	filename,
		const char *	title,
		const char *	dirname = `""`,
		const char *	relpath = `"../"`,
		Int_t	includeOutput = `kNoOutput`,
		const char *	context = `""`
	)

It converts a single text file to HTML.

Input: filename - name of the file to convert title - title which will be placed at the top of the HTML file dirname - optional parameter, if it's not specified, output will be placed in htmldoc/examples directory. relpath - optional parameter pointing to the THtml generated doc on the server, relative to the current page. includeOutput - if != kNoOutput, run the script passed as filename and store all created canvases in PNG files that are shown next to the converted source. Bitwise-ORing with kForceOutput re-runs the script even if output PNGs exist that are newer than the script. If kCompiledOutput is passed, the script is run through ACLiC (.x filename+) context - line shown verbatim at the top of the page; e.g. for links. If context is non-empty it is expected to also print the title.

NOTE: Output file name is the same as filename, but with extension .html

Definition at line 1463 of file THtml.cxx.

◆ CopyFileFromEtcDir()

Bool_t THtml::CopyFileFromEtcDir ( const char * filename ) const

Copy a file from $ROOTSYS/etc/html into GetOutputDir()

Definition at line 1908 of file THtml.cxx.

◆ CreateAuxiliaryFiles()

void THtml::CreateAuxiliaryFiles ( ) const

virtual

copy CSS, javascript file, etc to the output dir

Definition at line 1292 of file THtml.cxx.

◆ CreateHierarchy()

void THtml::CreateHierarchy ( )

Create the inheritance hierarchy diagram for all classes.

Definition at line 1929 of file THtml.cxx.

◆ CreateJavascript()

void THtml::CreateJavascript ( ) const

protectedvirtual

Write the default ROOT style sheet.

Definition at line 1938 of file THtml.cxx.

◆ CreateListOfClasses()

void THtml::CreateListOfClasses ( const char * filter )

protected

Create the list of all known classes.

Definition at line 1548 of file THtml.cxx.

◆ CreateListOfTypes()

void THtml::CreateListOfTypes ( )

protected

Create index of all data types and a page for each typedef-to-class.

Definition at line 1898 of file THtml.cxx.

◆ CreateStyleSheet()

void THtml::CreateStyleSheet ( ) const

protectedvirtual

Write the default ROOT style sheet.

Definition at line 1945 of file THtml.cxx.

◆ GetAuthorTag()

const TString & THtml::GetAuthorTag ( ) const

inline

Definition at line 305 of file THtml.h.

◆ GetCharset()

const TString & THtml::GetCharset ( ) const

inline

Definition at line 315 of file THtml.h.

◆ GetClass()

TClass * THtml::GetClass ( const char * name ) const

virtual

Return pointer to class with name.

Definition at line 2069 of file THtml.cxx.

◆ GetClassDocTag()

const TString & THtml::GetClassDocTag ( ) const

inline

Definition at line 304 of file THtml.h.

◆ GetCopyrightTag()

const TString & THtml::GetCopyrightTag ( ) const

inline

Definition at line 307 of file THtml.h.

◆ GetCounter()

const char * THtml::GetCounter ( ) const

inline

Definition at line 323 of file THtml.h.

◆ GetCounterFormat()

const char * THtml::GetCounterFormat ( ) const

inline

Definition at line 303 of file THtml.h.

◆ GetDeclFileName()

bool THtml::GetDeclFileName	(	TClass *	cl,
		Bool_t	filesys,
		TString &	out_name
	)		const

virtual

Return declaration file name; return the full path if filesys is true.

Definition at line 2098 of file THtml.cxx.

◆ GetDeclImplFileName()

bool THtml::GetDeclImplFileName	(	TClass *	cl,
		bool	filesys,
		bool	decl,
		TString &	out_name
	)		const

protectedvirtual

Combined implementation for GetDeclFileName(), GetImplFileName(): Return declaration / implementation file name (depending on decl); return the full path if filesys is true.

Definition at line 2116 of file THtml.cxx.

◆ GetDerivedClasses()

void THtml::GetDerivedClasses	(	TClass *	cl,
		std::map< TClass *, Int_t > &	derived
	)		const

fill derived with all classes inheriting from cl and their inheritance distance to cl

Definition at line 1957 of file THtml.cxx.

◆ GetDirDelimiter()

static const char * THtml::GetDirDelimiter ( )

inlinestatic

Definition at line 327 of file THtml.h.

◆ GetDocStyle()

const TString & THtml::GetDocStyle ( ) const

inline

Definition at line 316 of file THtml.h.

◆ GetDotDir()

const TString & THtml::GetDotDir ( ) const

inline

Definition at line 299 of file THtml.h.

◆ GetEtcDir()

const char * THtml::GetEtcDir ( ) const

virtual

Get the directory containing THtml's auxiliary files ($ROOTSYS/etc/html)

Definition at line 1345 of file THtml.cxx.

◆ GetFileDefinition()

const THtml::TFileDefinition & THtml::GetFileDefinition ( ) const

Return the TFileDefinition (or derived) object as set by SetFileDefinition(); create and return a TFileDefinition object if none was set.

Definition at line 1318 of file THtml.cxx.

◆ GetFooter()

const TString & THtml::GetFooter ( ) const

inline

Definition at line 309 of file THtml.h.

◆ GetHeader()

const TString & THtml::GetHeader ( ) const

inline

Definition at line 308 of file THtml.h.

◆ GetHomepage()

const TString & THtml::GetHomepage ( ) const

inline

Definition at line 310 of file THtml.h.

◆ GetHtmlFileName() [1/2]

const char * THtml::GetHtmlFileName ( const char * classname ) const

virtual

Get the html file name for a class named classname.

Returns 0 if the class is not documented.

Definition at line 2058 of file THtml.cxx.

◆ GetHtmlFileName() [2/2]

void THtml::GetHtmlFileName	(	TClass *	classPtr,
		TString &	filename
	)		const

virtual

Return real HTML filename.

Input: classPtr - pointer to a class filename - string containing a full name of the corresponding HTML file after the function returns.

Definition at line 1994 of file THtml.cxx.

◆ GetImplFileName()

bool THtml::GetImplFileName	(	TClass *	cl,
		Bool_t	filesys,
		TString &	out_name
	)		const

virtual

Return implementation file name.

Definition at line 2106 of file THtml.cxx.

◆ GetInputPath()

const TString & THtml::GetInputPath ( ) const

inline

Definition at line 295 of file THtml.h.

◆ GetLastUpdateTag()

const TString & THtml::GetLastUpdateTag ( ) const

inline

Definition at line 306 of file THtml.h.

◆ GetLibraryDependencies()

TList * THtml::GetLibraryDependencies ( )

inline

Definition at line 338 of file THtml.h.

◆ GetListOfClasses()

const TList * THtml::GetListOfClasses ( ) const

inline

Definition at line 341 of file THtml.h.

◆ GetListOfModules()

const TList * THtml::GetListOfModules ( ) const

inline

Definition at line 340 of file THtml.h.

◆ GetLocalFiles()

TFileSysDB * THtml::GetLocalFiles ( ) const

inline

Definition at line 342 of file THtml.h.

◆ GetMacroPath()

const TString & THtml::GetMacroPath ( ) const

inline

Definition at line 302 of file THtml.h.

◆ GetMakeClassMutex()

TVirtualMutex * THtml::GetMakeClassMutex ( ) const

inline

Definition at line 343 of file THtml.h.

◆ GetModuleDefinition()

const THtml::TModuleDefinition & THtml::GetModuleDefinition ( ) const

Return the TModuleDefinition (or derived) object as set by SetModuleDefinition(); create and return a TModuleDefinition object if none was set.

Definition at line 1304 of file THtml.cxx.

◆ GetModuleDocPath()

const TString & THtml::GetModuleDocPath ( ) const

inline

Definition at line 298 of file THtml.h.

◆ GetModuleMacroPath()

void THtml::GetModuleMacroPath	(	const TString &	module,
		TString &	out_path
	)		const

inline

Definition at line 324 of file THtml.h.

◆ GetModuleNameForClass()

void THtml::GetModuleNameForClass	(	TString &	module,
		TClass *	cl
	)		const

virtual

Return the module name for a given class.

Use the cached information from fDocEntityInfo.fClasses.

Definition at line 1533 of file THtml.cxx.

◆ GetNextClass()

TClassDocInfo * THtml::GetNextClass ( )

protected

Return the next class to be generated for MakeClassThreaded.

Definition at line 1362 of file THtml.cxx.

◆ GetOutputDir()

const TString & THtml::GetOutputDir ( Bool_t createDir = kTRUE ) const

Return the output directory as set by SetOutputDir().

Create it if it doesn't exist and if createDir is kTRUE.

Definition at line 2170 of file THtml.cxx.

◆ GetPathDefinition()

const THtml::TPathDefinition & THtml::GetPathDefinition ( ) const

Return the TModuleDefinition (or derived) object as set by SetModuleDefinition(); create and return a TModuleDefinition object if none was set.

Definition at line 1332 of file THtml.cxx.

◆ GetPathInfo()

const PathInfo_t & THtml::GetPathInfo ( ) const

inline

Definition at line 345 of file THtml.h.

◆ GetProductName()

const TString & THtml::GetProductName ( ) const

inline

Definition at line 294 of file THtml.h.

◆ GetSearchEngine()

const TString & THtml::GetSearchEngine ( ) const

inline

Definition at line 312 of file THtml.h.

◆ GetSearchStemURL()

const TString & THtml::GetSearchStemURL ( ) const

inline

Definition at line 311 of file THtml.h.

◆ GetURL()

const char * THtml::GetURL ( const char * lib = 0 ) const

Get the documentation URL for library lib.

If lib == 0 or no documentation URL has been set for lib, return the ROOT documentation URL. The return value is always != 0.

Definition at line 1388 of file THtml.cxx.

◆ GetViewCVS()

const TString & THtml::GetViewCVS ( ) const

inline

Definition at line 313 of file THtml.h.

◆ GetWikiURL()

const TString & THtml::GetWikiURL ( ) const

inline

Definition at line 314 of file THtml.h.

◆ GetXwho()

const TString & THtml::GetXwho ( ) const

inline

Definition at line 301 of file THtml.h.

◆ HaveDot()

Bool_t THtml::HaveDot ( )

Check whether dot is available in $PATH or in the directory set by SetDotPath()

Definition at line 1404 of file THtml.cxx.

◆ HelperDeleted()

void THtml::HelperDeleted ( THtml::THelperBase * who )

Inform the THtml object that one of its helper objects was deleted.

Called by THtml::HelperBase::~HelperBase().

Definition at line 1431 of file THtml.cxx.

◆ IsBatch()

Bool_t THtml::IsBatch ( ) const

inline

Definition at line 353 of file THtml.h.

◆ IsNamespace()

Bool_t THtml::IsNamespace ( const TClass * cl )

static

Check whether cl is a namespace.

Definition at line 2195 of file THtml.cxx.

◆ LoadAllLibs()

void THtml::LoadAllLibs ( )

static

Load all libraries known to ROOT via the rootmap system.

Definition at line 2203 of file THtml.cxx.

◆ MakeAll()

void THtml::MakeAll	(	Bool_t	force = `kFALSE`,
		const char *	filter = `"*"`,
		int	numthreads = `1`
	)

Produce documentation for all the classes specified in the filter (by default "*") To process all classes having a name starting with XX, do: html.MakeAll(kFALSE,"XX*"); If force=kFALSE (default), only the classes that have been modified since the previous call to this function will be generated.

If force=kTRUE, all classes passing the filter will be processed. If numthreads is != -1, use numthreads threads, else decide automatically based on the number of CPUs.

Definition at line 2219 of file THtml.cxx.

◆ MakeClass() [1/2]

void THtml::MakeClass	(	const char *	className,
		Bool_t	force = `kFALSE`
	)

Make HTML files for a single class.

Input: className - name of the class to process

Definition at line 2285 of file THtml.cxx.

◆ MakeClass() [2/2]

void THtml::MakeClass	(	void *	cdi_void,
		Bool_t	force = `kFALSE`
	)

protected

Make HTML files for a single class.

Input: cdi - doc info for class to process

Definition at line 2306 of file THtml.cxx.

◆ MakeClassThreaded()

void * THtml::MakeClassThreaded ( void * info )

staticprotected

Entry point of worker threads for multi-threaded MakeAll().

info points to an (internal) THtmlThreadInfo object containing the current THtml object, and whether "force" was passed to MakeAll(). The thread will poll GetNextClass() until no further class is available.

Definition at line 2346 of file THtml.cxx.

◆ MakeIndex()

void THtml::MakeIndex ( const char * filter = "*" )

Create the index files for the product, modules, all types, etc.

By default all classes are indexed (if filter="*"); to generate an index for all classes starting with "XX", do html.MakeIndex("XX*");

Definition at line 2362 of file THtml.cxx.

◆ MakeTree()

void THtml::MakeTree	(	const char *	className,
		Bool_t	force = `kFALSE`
	)

Make an inheritance tree.

Input: className - name of the class to process

Definition at line 2386 of file THtml.cxx.

◆ ReplaceSpecialChars()

void THtml::ReplaceSpecialChars	(	std::ostream &	,
		const char *
	)

inline

Definition at line 355 of file THtml.h.

◆ SetAuthorTag()

void THtml::SetAuthorTag ( const char * tag )

inline

Definition at line 277 of file THtml.h.

◆ SetBatch()

void THtml::SetBatch ( Bool_t batch = kTRUE )

inline

Definition at line 352 of file THtml.h.

◆ SetCharset()

void THtml::SetCharset ( const char * charset )

inline

Definition at line 287 of file THtml.h.

◆ SetClassDocTag()

void THtml::SetClassDocTag ( const char * tag )

inline

Definition at line 276 of file THtml.h.

◆ SetCopyrightTag()

void THtml::SetCopyrightTag ( const char * tag )

inline

Definition at line 279 of file THtml.h.

◆ SetCounterFormat()

void THtml::SetCounterFormat ( const char * format )

inline

Definition at line 275 of file THtml.h.

◆ SetDeclFileName()

void THtml::SetDeclFileName	(	TClass *	cl,
		const char *	filename
	)

Explicitly set a decl file name for TClass cl.

Definition at line 2487 of file THtml.cxx.

◆ SetDocPath()

void THtml::SetDocPath ( const char * path )

inline

Definition at line 268 of file THtml.h.

◆ SetDocStyle()

void THtml::SetDocStyle ( const char * style )

inline

Definition at line 288 of file THtml.h.

◆ SetDotDir()

void THtml::SetDotDir ( const char * dir )

inline

Definition at line 269 of file THtml.h.

◆ SetEscape()

void THtml::SetEscape ( char = '\\' )

inline

Definition at line 358 of file THtml.h.

◆ SetEtcDir()

void THtml::SetEtcDir ( const char * dir )

inline

Definition at line 267 of file THtml.h.

◆ SetFileDefinition()

void THtml::SetFileDefinition ( const TFileDefinition & fd )

Set the file defining object to be used; can also be a user derived object (a la traits).

Definition at line 2433 of file THtml.cxx.

◆ SetFooter()

void THtml::SetFooter ( const char * file )

inline

Definition at line 281 of file THtml.h.

◆ SetFoundDot()

void THtml::SetFoundDot ( Bool_t found = kTRUE )

Set whether "dot" (a GraphViz utility) is available.

Definition at line 2403 of file THtml.cxx.

◆ SetHeader()

void THtml::SetHeader ( const char * file )

inline

Definition at line 280 of file THtml.h.

◆ SetHomepage()

void THtml::SetHomepage ( const char * url )

inline

Definition at line 282 of file THtml.h.

◆ SetImplFileName()

void THtml::SetImplFileName	(	TClass *	cl,
		const char *	filename
	)

Explicitly set a impl file name for TClass cl.

Definition at line 2500 of file THtml.cxx.

◆ SetIncludePath()

void THtml::SetIncludePath ( const char * dir )

inline

Definition at line 266 of file THtml.h.

◆ SetInputDir()

void THtml::SetInputDir ( const char * dir )

Set the directory containing the source files.

The source file for a class MyClass will be searched by prepending dir to the value of MyClass::Class()->GetImplFileName() - which can contain directory information! Also resets the class structure, in case new files can be found after this call.

Definition at line 2462 of file THtml.cxx.

◆ SetLastUpdateTag()

void THtml::SetLastUpdateTag ( const char * tag )

inline

Definition at line 278 of file THtml.h.

◆ SetLibURL()

void THtml::SetLibURL	(	const char *	lib,
		const char *	url
	)

inline

Definition at line 271 of file THtml.h.

◆ SetLocalFiles()

void THtml::SetLocalFiles ( ) const

protected

Fill the files available in the file system below fPathInfo.fInputPath.

Definition at line 2411 of file THtml.cxx.

◆ SetMacroPath()

void THtml::SetMacroPath ( const char * path )

inline

Definition at line 273 of file THtml.h.

◆ SetModuleDefinition()

void THtml::SetModuleDefinition ( const TModuleDefinition & md )

Set the module defining object to be used; can also be a user derived object (a la traits).

Definition at line 2421 of file THtml.cxx.

◆ SetOutputDir()

void THtml::SetOutputDir ( const char * dir )

Set the directory where the HTML pages shuold be written to.

If the directory does not exist it will be created when needed.

Definition at line 2476 of file THtml.cxx.

◆ SetPathDefinition()

void THtml::SetPathDefinition ( const TPathDefinition & pd )

Set the path defining object to be used; can also be a user derived object (a la traits).

Definition at line 2445 of file THtml.cxx.

◆ SetProductName()

void THtml::SetProductName ( const char * product )

inline

Definition at line 262 of file THtml.h.

◆ SetRootURL()

void THtml::SetRootURL ( const char * url )

inline

Definition at line 270 of file THtml.h.

◆ SetSearchEngine()

void THtml::SetSearchEngine ( const char * url )

inline

Definition at line 284 of file THtml.h.

◆ SetSearchStemURL()

void THtml::SetSearchStemURL ( const char * url )

inline

Definition at line 283 of file THtml.h.

◆ SetSourceDir()

void THtml::SetSourceDir ( const char * dir )

inline

Definition at line 265 of file THtml.h.

◆ SetViewCVS()

void THtml::SetViewCVS ( const char * url )

inline

Definition at line 285 of file THtml.h.

◆ SetWikiURL()

void THtml::SetWikiURL ( const char * url )

inline

Definition at line 286 of file THtml.h.

◆ SetXwho()

void THtml::SetXwho ( const char * xwho )

inline

Definition at line 272 of file THtml.h.

◆ ShortType()

const char * THtml::ShortType ( const char * name ) const

Get short type name, i.e. with default templates removed.

Definition at line 2513 of file THtml.cxx.

◆ SortListOfModules()

void THtml::SortListOfModules ( )

inline

Definition at line 339 of file THtml.h.

Member Data Documentation

◆ fBatch

Bool_t THtml::fBatch

protected

Definition at line 424 of file THtml.h.

◆ fCounter

TString THtml::fCounter

protected

Definition at line 408 of file THtml.h.

◆ fCounterFormat

TString THtml::fCounterFormat

protected

Definition at line 409 of file THtml.h.

◆ fDocEntityInfo

DocEntityInfo_t THtml::fDocEntityInfo

protected

Definition at line 419 of file THtml.h.

◆ fDocSyntax

DocSyntax_t THtml::fDocSyntax

protected

Definition at line 415 of file THtml.h.

◆ fFileDef

TFileDefinition* THtml::fFileDef

mutableprotected

Definition at line 422 of file THtml.h.

◆ fGClient

TGClient* THtml::fGClient

protected

Definition at line 414 of file THtml.h.

◆ fLinkInfo

LinkInfo_t THtml::fLinkInfo

protected

Definition at line 416 of file THtml.h.

◆ fLocalFiles

TFileSysDB* THtml::fLocalFiles

mutableprotected

Definition at line 423 of file THtml.h.

◆ fMakeClassMutex

TVirtualMutex* THtml::fMakeClassMutex

protected

Definition at line 413 of file THtml.h.

◆ fModuleDef

TModuleDefinition* THtml::fModuleDef

mutableprotected

Definition at line 421 of file THtml.h.

◆ fOutputStyle

OutputStyle_t THtml::fOutputStyle

protected

Definition at line 417 of file THtml.h.

◆ fPathDef

TPathDefinition* THtml::fPathDef

mutableprotected

Definition at line 420 of file THtml.h.

◆ fPathInfo

PathInfo_t THtml::fPathInfo

mutableprotected

Definition at line 418 of file THtml.h.

◆ fProductName

TString THtml::fProductName

protected

Definition at line 410 of file THtml.h.

◆ fThreadedClassCount

Int_t THtml::fThreadedClassCount

protected

Definition at line 412 of file THtml.h.

◆ fThreadedClassIter

TIter* THtml::fThreadedClassIter

protected

Definition at line 411 of file THtml.h.

Libraries for THtml:

[legend]

Protected Attributes
Bool_t	fBatch

TString	fCounter

TString	fCounterFormat

DocEntityInfo_t	fDocEntityInfo

DocSyntax_t	fDocSyntax

TFileDefinition *	fFileDef

TGClient *	fGClient

LinkInfo_t	fLinkInfo

TFileSysDB *	fLocalFiles

TVirtualMutex *	fMakeClassMutex

TModuleDefinition *	fModuleDef

OutputStyle_t	fOutputStyle

TPathDefinition *	fPathDef

PathInfo_t	fPathInfo

TString	fProductName

Int_t	fThreadedClassCount

TIter *	fThreadedClassIter

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EConvertOutput

Constructor & Destructor Documentation

◆ THtml()

◆ ~THtml()

Member Function Documentation

◆ AddMacroPath()

◆ Convert()

◆ CopyFileFromEtcDir()

◆ CreateAuxiliaryFiles()

◆ CreateHierarchy()

◆ CreateJavascript()

◆ CreateListOfClasses()

◆ CreateListOfTypes()

◆ CreateStyleSheet()

◆ GetAuthorTag()

◆ GetCharset()

◆ GetClass()

◆ GetClassDocTag()

◆ GetCopyrightTag()

◆ GetCounter()

◆ GetCounterFormat()

◆ GetDeclFileName()

◆ GetDeclImplFileName()

◆ GetDerivedClasses()

◆ GetDirDelimiter()

◆ GetDocStyle()

◆ GetDotDir()

◆ GetEtcDir()

◆ GetFileDefinition()

◆ GetFooter()

◆ GetHeader()

◆ GetHomepage()

◆ GetHtmlFileName() [1/2]

◆ GetHtmlFileName() [2/2]

◆ GetImplFileName()

◆ GetInputPath()

◆ GetLastUpdateTag()

◆ GetLibraryDependencies()

◆ GetListOfClasses()

◆ GetListOfModules()

◆ GetLocalFiles()

◆ GetMacroPath()

◆ GetMakeClassMutex()

◆ GetModuleDefinition()

◆ GetModuleDocPath()

◆ GetModuleMacroPath()

◆ GetModuleNameForClass()

◆ GetNextClass()

◆ GetOutputDir()

◆ GetPathDefinition()

◆ GetPathInfo()

◆ GetProductName()

◆ GetSearchEngine()

◆ GetSearchStemURL()

◆ GetURL()

◆ GetViewCVS()

◆ GetWikiURL()

◆ GetXwho()

◆ HaveDot()

◆ HelperDeleted()

◆ IsBatch()

◆ IsNamespace()

◆ LoadAllLibs()

◆ MakeAll()

◆ MakeClass() [1/2]

◆ MakeClass() [2/2]

◆ MakeClassThreaded()

◆ MakeIndex()

◆ MakeTree()

◆ ReplaceSpecialChars()

◆ SetAuthorTag()