Definition at line 37 of file TDocOutput.h.

Public Types
enum	EFileType { kSource , kInclude , kTree , kDoc }

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

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

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

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

Public Member Functions
	TDocOutput (THtml &html)

	~TDocOutput () override

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 "../").

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.

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

virtual void	CreateClassIndex ()
	Create index of all classes.

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

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

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

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

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

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

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

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

const char *	GetExtension () const

THtml *	GetHtml ()

TClass *	IsA () const override

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

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.

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

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

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

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

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

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

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

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

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

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

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

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.

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

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

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

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

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

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.

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

virtual void	Clear (Option_t *="")

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

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

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

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

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

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

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

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

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

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

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

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

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

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

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

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

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

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

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

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

virtual Option_t *	GetOption () const

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

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

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

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

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.

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

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

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

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

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

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

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

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.

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

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

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

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

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

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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.

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

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

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

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

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

void	ResetBit (UInt_t f)

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

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

void	SetBit (UInt_t f)

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

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

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.

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

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

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

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

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

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

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

Protected Types
enum	EGraphvizTool { kDot , kNeato , kFdp , kCirco }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

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

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.

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.

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

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

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

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

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

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

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.

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

void	MakeZombie ()

Protected Attributes
THtml *	fHtml

#include <TDocOutput.h>

Inheritance diagram for TDocOutput:

[legend]

Member Enumeration Documentation

◆ EFileType

enum TDocOutput::EFileType

Enumerator
kSource
kInclude
kTree
kDoc

Definition at line 65 of file TDocOutput.h.

◆ EGraphvizTool

enum TDocOutput::EGraphvizTool

protected

Enumerator
kDot
kNeato
kFdp
kCirco

Definition at line 39 of file TDocOutput.h.

Constructor & Destructor Documentation

◆ TDocOutput()

TDocOutput::TDocOutput ( THtml & html )

Definition at line 255 of file TDocOutput.cxx.

◆ ~TDocOutput()

TDocOutput::~TDocOutput ( )

override

Definition at line 260 of file TDocOutput.cxx.

Member Function Documentation

◆ AddLink()

void TDocOutput::AddLink	(	TSubString &	str,
		TString &	link,
		const char *	comment
	)

protected

Add a link around str, with title comment.

Update str so it surrounds the link.

Definition at line 267 of file TDocOutput.cxx.

◆ AdjustSourcePath()

void TDocOutput::AdjustSourcePath	(	TString &	line,
		const char *	relpath = `"../"`
	)

virtual

adjust the path of links for source files, which are in src/, but need to point to relpath (usually "../").

Simply replaces "=\"./" by "=\"../"

Definition at line 296 of file TDocOutput.cxx.

◆ CaseInsensitiveSort()

int TDocOutput::CaseInsensitiveSort	(	const void *	name1,
		const void *	name2
	)

protected

◆ Class()

static TClass * TDocOutput::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TDocOutput::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TDocOutput::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 110 of file TDocOutput.h.

◆ Convert()

void TDocOutput::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.

outfilename doesn't have an extension yet; up to us to decide. We generate HTML, so our extension is ".html". See THtml::Convert() for the other parameters.

Definition at line 310 of file TDocOutput.cxx.

◆ CopyHtmlFile()

Bool_t TDocOutput::CopyHtmlFile	(	const char *	sourceName,
		const char *	destName = `""`
	)

Copy file to HTML directory.

Input: sourceName - source file name (fully qualified i.e. file system path) destName - optional destination name, if not specified it would be the same as the source file name

Output: TRUE if file is successfully copied, or FALSE if it's not

NOTE: The destination directory is always fHtml->GetOutputDir()

Definition at line 592 of file TDocOutput.cxx.

◆ CreateClassIndex()

void TDocOutput::CreateClassIndex ( )

virtual

Create index of all classes.

Definition at line 692 of file TDocOutput.cxx.

◆ CreateClassTypeDefs()

void TDocOutput::CreateClassTypeDefs ( )

virtual

Create a forwarding page for each typedef pointing to a class.

Definition at line 1169 of file TDocOutput.cxx.

◆ CreateHierarchy()

void TDocOutput::CreateHierarchy ( )

virtual

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 639 of file TDocOutput.cxx.

◆ CreateModuleIndex()

void TDocOutput::CreateModuleIndex ( )

virtual

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

Also creates the library dependency plot if dot exists, see THtml::HaveDot().

Definition at line 800 of file TDocOutput.cxx.

◆ CreateProductIndex()

void TDocOutput::CreateProductIndex ( )

virtual

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

Definition at line 1126 of file TDocOutput.cxx.

◆ CreateTypeIndex()

void TDocOutput::CreateTypeIndex ( )

virtual

Create index of all data types.

Definition at line 1275 of file TDocOutput.cxx.

◆ DeclFileName()

static const char * TDocOutput::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 110 of file TDocOutput.h.

◆ DecorateEntityBegin()

void TDocOutput::DecorateEntityBegin	(	TString &	str,
		Ssiz_t &	pos,
		TDocParser::EParseContext	type
	)

virtual

Add some colors etc to a source entity, contained in str.

The type of what's contained in str is given by type. It's called e.g. by TDocParser::BeautifyLine(). This function should assume that only str.Begin() is valid. When inserting into str.String(), str.Begin() must be updated.

Definition at line 1367 of file TDocOutput.cxx.

◆ DecorateEntityEnd()

void TDocOutput::DecorateEntityEnd	(	TString &	str,
		Ssiz_t &	pos,
		TDocParser::EParseContext	type
	)

virtual

Add some colors etc to a source entity, contained in str.

The type of what's contained in str is given by type. It's called e.g. by TDocParser::BeautifyLine(). This function should assume that only str."End()" (i.e. str.Begin()+str.Length()) is valid. When inserting into str.String(), str.Length() must be updated.

Definition at line 1407 of file TDocOutput.cxx.

◆ FixupAuthorSourceInfo()

void TDocOutput::FixupAuthorSourceInfo ( TString & authors )

virtual

Special author treatment; called when TDocParser::fSourceInfo[kInfoAuthor] is set.

Modifies the author(s) description, which is a comma separated list of tokens either in the format (i) "FirstName LastName " or (ii) "FirstName LastName <link> more stuff" The first one generates an XWho link (CERN compatible), the second a http link (WORLD compatible), <link> being e.g. user@.nosp@m.host.nosp@m..bla or http://www.host.bla/page.

Definition at line 1448 of file TDocOutput.cxx.

◆ GetExtension()

const char * TDocOutput::GetExtension ( ) const

inline

Definition at line 89 of file TDocOutput.h.

◆ GetHtml()

THtml * TDocOutput::GetHtml ( )

inline

Definition at line 90 of file TDocOutput.h.

◆ IsA()

TClass * TDocOutput::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 110 of file TDocOutput.h.

◆ IsModified()

Bool_t TDocOutput::IsModified	(	TClass *	classPtr,
		EFileType	type
	)

virtual

Check if file is modified.

Input: classPtr - pointer to the class type - file type to compare with values: kSource, kInclude, kTree

Output: TRUE - if file is modified since last time FALSE - if file is up to date

Definition at line 1515 of file TDocOutput.cxx.

◆ NameSpace2FileName()

void TDocOutput::NameSpace2FileName ( TString & name )

virtual

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.

Definition at line 1617 of file TDocOutput.cxx.

◆ ProcessDocInDir()

void TDocOutput::ProcessDocInDir	(	std::ostream &	out,
		const char *	indir,
		const char *	outdir,
		const char *	linkdir
	)

protected

Write links to files indir/*.txt, indir/*.html (non-recursive) to out.

If one of the files is called "index.{html,txt}" it will be included in out (instead of copying it to outdir and generating a link to linkdir). txt files are passed through Convert(). The files' links are sorted alphabetically.

Definition at line 1676 of file TDocOutput.cxx.

◆ ReferenceEntity() [1/4]

void TDocOutput::ReferenceEntity	(	TSubString &	str,
		TClass *	entity,
		const char *	comment = `0`
	)

virtual

Create a reference to a class documentation page.

str encloses the text to create the reference for (e.g. name of instance). comment will be added e.g. as tooltip text. After the reference is put into str.String(), str will enclose the reference and the original text. Example: Input: str.String(): "a gHtml test" str.Begin(): 2 str.Length(): 5 Output: str.String(): "a <a href="THtml.html">gHtml</a> test" str.Begin(): 2 str.Length(): 30

Definition at line 1788 of file TDocOutput.cxx.

◆ ReferenceEntity() [2/4]

void TDocOutput::ReferenceEntity	(	TSubString &	str,
		TDataMember *	entity,
		const char *	comment = `0`
	)

virtual

Create a reference to a data member documentation page.

str encloses the text to create the reference for (e.g. name of instance). comment will be added e.g. as tooltip text. After the reference is put into str.String(), str will enclose the reference and the original text. Example: Input: str.String(): "a gHtml test" str.Begin(): 2 str.Length(): 5 Output: str.String(): "a <a href="THtml.html">gHtml</a> test" str.Begin(): 2 str.Length(): 30

Definition at line 1814 of file TDocOutput.cxx.

◆ ReferenceEntity() [3/4]

void TDocOutput::ReferenceEntity	(	TSubString &	str,
		TDataType *	entity,
		const char *	comment = `0`
	)

virtual

Create a reference to a type documentation page.

str encloses the text to create the reference for (e.g. name of instance). comment will be added e.g. as tooltip text. After the reference is put into str.String(), str will enclose the reference and the original text. Example: Input: str.String(): "a gHtml test" str.Begin(): 2 str.Length(): 5 Output: str.String(): "a <a href="THtml.html">gHtml</a> test" str.Begin(): 2 str.Length(): 30

Definition at line 1866 of file TDocOutput.cxx.

◆ ReferenceEntity() [4/4]

void TDocOutput::ReferenceEntity	(	TSubString &	str,
		TMethod *	entity,
		const char *	comment = `0`
	)

virtual

Create a reference to a method documentation page.

str encloses the text to create the reference for (e.g. name of instance). comment will be added e.g. as tooltip text. After the reference is put into str.String(), str will enclose the reference and the original text. Example: Input: str.String(): "a gHtml test" str.Begin(): 2 str.Length(): 5 Output: str.String(): "a <a href="THtml.html">gHtml</a> test" str.Begin(): 2 str.Length(): 30

Definition at line 1909 of file TDocOutput.cxx.

◆ ReferenceIsRelative()

Bool_t TDocOutput::ReferenceIsRelative ( const char * reference ) const

virtual

Check whether reference is a relative reference, and can (or should) be prependen by relative paths.

For HTML, check that it doesn't start with "http://" or "https://"

Definition at line 1951 of file TDocOutput.cxx.

◆ ReplaceSpecialChars() [1/4]

const char * TDocOutput::ReplaceSpecialChars ( char c )

virtual

Replace ampersand, less-than and greater-than character, writing to out.

If 0 is returned, no replacement needs to be done.

Definition at line 1962 of file TDocOutput.cxx.

◆ ReplaceSpecialChars() [2/4]

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

Replace ampersand, less-than and greater-than characters, writing to out.

Input: out - output file stream string - pointer to an array of characters

Definition at line 2024 of file TDocOutput.cxx.

◆ ReplaceSpecialChars() [3/4]

void TDocOutput::ReplaceSpecialChars ( TString & text )

Replace ampersand, less-than and greater-than character.

Input: text - text where replacement will happen,

Definition at line 2010 of file TDocOutput.cxx.

◆ ReplaceSpecialChars() [4/4]

void TDocOutput::ReplaceSpecialChars	(	TString &	text,
		Ssiz_t &	pos
	)

Replace ampersand, less-than and greater-than character.

Input: text - text where replacement will happen, pos - index of char to be replaced; will point to next char to be replaced when function returns

Definition at line 1992 of file TDocOutput.cxx.

◆ RunDot()

Bool_t TDocOutput::RunDot	(	const char *	filename,
		std::ostream *	outMap = `0`,
		EGraphvizTool	gvwhat = `kDot`
	)

protected

Run filename".dot", creating filename".png", and - if outMap is !=0, filename".map", which gets then included literally into outMap.

Definition at line 2040 of file TDocOutput.cxx.

◆ Streamer()

void TDocOutput::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TDocOutput::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 110 of file TDocOutput.h.

◆ WriteHtmlFooter() [1/2]

void TDocOutput::WriteHtmlFooter	(	std::ostream &	out,
		const char *	dir,
		const char *	lastUpdate,
		const char *	author,
		const char *	copyright,
		const char *	footer
	)

protected

Write HTML footer.

Internal method invoked by the overload

Definition at line 2217 of file TDocOutput.cxx.

◆ WriteHtmlFooter() [2/2]

void TDocOutput::WriteHtmlFooter	(	std::ostream &	out,
		const char *	dir = `""`,
		const char *	lastUpdate = `""`,
		const char *	author = `""`,
		const char *	copyright = `""`
	)

virtual

Write HTML footer.

Input: out - output file stream dir - usually equal to "" or "../", depends of current file directory position, i.e. if file is in the fHtml->GetOutputDir(), then dir will be "" lastUpdate - last update string author - author's name copyright - copyright note

Allows optional user provided footer to be written. Root.Html.Footer holds the file name for this footer. For details see THtml::WriteHtmlHeader (here, the "+" means the user's footer is written in front of Root's!) Occurrences of AUTHOR%, CHANGED%, GENERATED%, and COPYRIGHT% in the user's file are replaced by their corresponding values (author, lastUpdate, today, and copyright) before written to out. If no author is set (author == "", e.g. for ClassIndex.html") skip the whole line of the footer template containing AUTHOR%. Accordingly for COPYRIGHT%.

Definition at line 2287 of file TDocOutput.cxx.

◆ WriteHtmlHeader() [1/2]

void TDocOutput::WriteHtmlHeader	(	std::ostream &	out,
		const char *	title,
		const char *	dir = `""`,
		TClass *	cls = `0`
	)

virtual

Write HTML header.

Input: out - output file stream title - title for the HTML page cls - current class dir - relative directory to reach the top ("" for html doc, "../" for src/*cxx.html etc)

evaluates the Root.Html.Header setting:

if not set, the standard header is written. (ROOT)
if set, and ends with a "+", the standard header is written and this file included afterwards. (ROOT, USER)
if set but doesn't end on "+" the file specified will be written instead of the standard header (USER)

Any occurrence of "%TITLE%" (without the quotation marks) in the user provided header file will be replaced by the value of this method's parameter "title" before written to the output file. CLASS% is replaced by the class name, INCFILE% by the header file name as given by TClass::GetDeclFileName() and SRCFILE% by the source file name as given by TClass::GetImplFileName(). If the header is written for a non-class page, i.e. cls==0, lines containing CLASS%, INCFILE%, or SRCFILE% will be skipped.

Definition at line 2189 of file TDocOutput.cxx.

◆ WriteHtmlHeader() [2/2]

void TDocOutput::WriteHtmlHeader	(	std::ostream &	out,
		const char *	titleNoSpecial,
		const char *	dir,
		TClass *	cls,
		const char *	header
	)

protected

Write HTML header.

Internal method invoked by the overload

Definition at line 2109 of file TDocOutput.cxx.

◆ WriteLineNumbers()

void TDocOutput::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.

Create links to the source file's line number and anchors, such that one can jump to SourceFile.cxx.html#27 (using the anchor), and one can copy and paste the link into e.g. gdb to get the text "SourceFile.cxx:27".

Definition at line 2340 of file TDocOutput.cxx.

◆ WriteLocation()

void TDocOutput::WriteLocation	(	std::ostream &	out,
		TModuleDocInfo *	module,
		const char *	classname = `0`
	)

protected

make a link to the description

Definition at line 2423 of file TDocOutput.cxx.

◆ WriteModuleLinks() [1/2]

void TDocOutput::WriteModuleLinks ( std::ostream & out )

protected

Create a div containing links to all topmost modules.

Definition at line 2312 of file TDocOutput.cxx.

◆ WriteModuleLinks() [2/2]

void TDocOutput::WriteModuleLinks	(	std::ostream &	out,
		TModuleDocInfo *	super
	)

protected

Create a div containing links to all modules.

Definition at line 2356 of file TDocOutput.cxx.

◆ WriteSearch()

void TDocOutput::WriteSearch ( std::ostream & out )

protectedvirtual

Write a search link or a search box, based on THtml::GetSearchStemURL() and THtml::GetSearchEngine().

The first one is preferred.

Definition at line 2386 of file TDocOutput.cxx.

◆ WriteTopLinks()

void TDocOutput::WriteTopLinks	(	std::ostream &	out,
		TModuleDocInfo *	module,
		const char *	classname = `0`,
		Bool_t	withLocation = `kTRUE`
	)

protected

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.

Definition at line 2468 of file TDocOutput.cxx.

Member Data Documentation

◆ fHtml

THtml* TDocOutput::fHtml

protected

Definition at line 46 of file TDocOutput.h.

html/inc/TDocOutput.h

html/src/TDocOutput.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

◆ EFileType

◆ EGraphvizTool

Constructor & Destructor Documentation

◆ TDocOutput()

◆ ~TDocOutput()

Member Function Documentation

◆ AddLink()

◆ AdjustSourcePath()

◆ CaseInsensitiveSort()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Convert()

◆ CopyHtmlFile()

◆ CreateClassIndex()

◆ CreateClassTypeDefs()

◆ CreateHierarchy()

◆ CreateModuleIndex()

◆ CreateProductIndex()

◆ CreateTypeIndex()

◆ DeclFileName()

◆ DecorateEntityBegin()

◆ DecorateEntityEnd()

◆ FixupAuthorSourceInfo()

◆ GetExtension()

◆ GetHtml()

◆ IsA()

◆ IsModified()

◆ NameSpace2FileName()

◆ ProcessDocInDir()

◆ ReferenceEntity() [1/4]

◆ ReferenceEntity() [2/4]

◆ ReferenceEntity() [3/4]

◆ ReferenceEntity() [4/4]

◆ ReferenceIsRelative()

◆ ReplaceSpecialChars() [1/4]

◆ ReplaceSpecialChars() [2/4]

◆ ReplaceSpecialChars() [3/4]

◆ ReplaceSpecialChars() [4/4]

◆ RunDot()

◆ Streamer()

◆ StreamerNVirtual()

◆ WriteHtmlFooter() [1/2]

◆ WriteHtmlFooter() [2/2]

◆ WriteHtmlHeader() [1/2]

◆ WriteHtmlHeader() [2/2]

◆ WriteLineNumbers()

◆ WriteLocation()

◆ WriteModuleLinks() [1/2]

◆ WriteModuleLinks() [2/2]

◆ WriteSearch()

◆ WriteTopLinks()

Member Data Documentation

◆ fHtml