class TDocOutput: public TObject

 Add a link around str, with title comment.
 Update str so it surrounds the link.

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

 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.

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

 Create a hierarchical class list
 The algorithm descends from the base classes and branches into
 all derived classes. Mixing classes are displayed several times.

 Create index of all classes

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

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

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

 Create index of all data types

 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.

 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.

 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.
 <mailto:user@host.bla> or <http://www.host.bla/page>.

 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

 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

 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.

 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

 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

 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

 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

 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://"

 Replace ampersand, less-than and greater-than character, writing to out.
 If 0 is returned, no replacement needs to be done.

 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

 Replace ampersand, less-than and greater-than character


 Input: text - text where replacement will happen,

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


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

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

 Write HTML header

 Internal method invoked by the overload

 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.

 Write HTML footer

 Internal method invoked by the overload

 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!) Occurences
 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%.

 Create a div containing links to all topmost modules

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

 Create a div containing links to all modules

 Write a search link or a search box, based on THtml::GetSearchStemURL()
 and THtml::GetSearchEngine(). The first one is preferred.

 make a link to the description

 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.