Logo ROOT  
Reference Guide
TDocOutput Class Reference

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

 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
 
THtmlGetHtml ()
 
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...
 
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 TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () 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_tGetOption () 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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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...
 

Protected Types

enum  EGraphvizTool { kDot, kNeato, kFdp, kCirco }
 

Protected Member Functions

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

THtmlfHtml
 

Additional Inherited Members

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

Inheritance diagram for TDocOutput:
[legend]

Member Enumeration Documentation

◆ 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 ( )
virtual

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

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

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

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

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

Libraries for TDocOutput:
[legend]

The documentation for this class was generated from the following files: