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.

 Default destructor

 Add accessible (i.e. non-private) methods of base class bc 
 and its base classes' methods to methodNames.
 If bc==0, we add fCurrentClass's methods (and also private functions).

 Add data members of fCurrentClass and of bc to datamembers, recursively.
 Real data members are in idx 0..2 (public, protected, private access),
 enum constants in idx 3..5.

 Create HTML files for a single class.

 Open a Class.cxx.html file, where Class is defined by classPtr, and .cxx.html by extension
 It's created in fOutputDir/src. If successful, the HTML header is written to out.

 Create an anchor from the given line, by hashing it and
 convertig the hash into a custom base64 string.

 Put colors around tags, create links, escape characters.
 In short: make a nice HTML page out of C++ code, and put it into srcOut.
 Create an anchor at the beginning of the line, and put its name into
 anchor, if set.

 Search for a method starting at posMethodName, and return its return type, 
 its name, and its arguments. If the end of arguments is not found in the 
 current line, get a new line from sourceFile, beautify it to srcOut, creating
 an anchor as necessary. When this function returns, posMethodName points to the
 end of the function declaration, i.e. right after the arguments' closing bracket.
 If posMethodName == kNPOS, we look for the first matching method in fMethodNames.

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

 Extracts comments from the current line into comment, 
 updating whether a class description was found (foundClassDescription).
 Returns kTRUE if comment found.

 Collect methods from the source or header file called filename.
 It generates a beautified version of the source file on the fly;
 the output file is given by the fCurrentClass's name, and sourceExt.
 Documentation is extracted to out.
   lookForSourceInfo: if set, author, lastUpdate, and copyright are 
     extracted (i.e. the values contained in fSourceInfo)
   useDocxxStyle: if set, documentation can be in front of the method
     name, not only inside the method. Useful doc Doc++/Doxygen style,
     and inline methods.
   lookForClassDescr: if set, the first line matching the class description 
     rules is assumed to be the class description for fCurrentClass; the 
     description is written to out.
   methodPattern: if set, methods have to be prepended by this tag. Usually
     the class name + "::". In header files, looking for in-place function
     definitions, this should be 0. In that case, only functions in 
     fMethodNames are searched for.

 Given fCurrentClass, look for methods in its source file, 
 and extract documentation to out, while beautifying the source 
 file in parallel.

 Given fCurrentClass, look for methods in its header file, 
 and extract documentation to out.

 Given fCurrentClass, look for methods in its header file's
 class declaration block, and extract documentation to out,
 while beautifying the header file in parallel.

 This function builds the description of the class


 Input: out      - output file stream

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

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

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


 Input: filename - output dot file incl. path

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

 Input: filename - output dot file incl. path

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

 Input: filename - output dot file incl. path

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

 Input: filename - output dot file incl. path

 This function builds the class charts for one class in GraphViz/Dot format,
 i.e. the inheritance diagram, the include dependencies, and the library
 dependency.

 Input: out      - output file stream

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


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

 It makes a graphical class tree


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

 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.

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

 Copy file to HTML directory


  Input: sourceName - source file name
         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 fOutputDir

 Create an index


 Input: classNames      - pointer to an array of class names
        numberOfClasses - number of elements

 It creates several index files


 Input: fileNames     - pointer to an array of file names
        numberOfNames - number of elements in the fileNames array
        maxLen        - maximum length of a single name

 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 a hierarchical class list
 The algorithm descends from the base classes and branches into
 all derived classes. Mixing classes are displayed several times.

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

 Returns the module a class with filename belongs to.
 For ROOT, this is determined by MODULE/src/*.cxx or MODULE/inc/*.h. 
 Math/GenVector (MATHCORE) and Math/Matrix (SMATRIX) get special
 treatment.
 All classes not fitting into this layout are assigned to the
 module USER.

 Create the list of all known classes

 Create list of all data types

 Write the default ROOT style sheet.

 Write the default ROOT style sheet.

 Expand keywords in text, writing to out.

 Find keywords in keyword and create URLs around them. Escape characters with a 
 special meaning for HTML. Protect "Begin_Html"/"End_Html" pairs, and set the
 parsing context. Evaluate sequences like a::b->c.

 Expand preprocessor statements


 Input: out  - output file stream

  NOTE: Looks for the #include statements and
        creates link to the corresponding file
        if such file exists

 It discards any directory information inside filename


  Input: filename - pointer to the file name

 Output: pointer to the string containing just a file name
         without any other directory information, i.e.
         '/usr/root/test.dat' will return 'test.dat'

 Find the source file. If filename contains a path it will be used
 together with the possible source prefix. If not found we try
 old algorithm, by stripping off the path and trying to find it in the
 specified source search path.

 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. 

*-*-*-*-*Return pointer to class with name*-*-*-*-*-*-*-*-*-*-*-*-*
*-*      =================================

 Return declaration file name

 Return implementation file name

 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

 Check if c is a valid C++ name character


  Input: c - a single character

 Output: TRUE if c is a valid C++ name character
         and FALSE if it's not.

   NOTE: Valid name characters are [a..zA..Z0..9_~],

 Check if c is a valid first character for C++ name


  Input: c - a single character

 Output: TRUE if c is a valid first character for C++ name,
         and FALSE if it's not.

   NOTE: Valid first characters are [a..zA..Z_~]

 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.

 Make HTML files for a single class


 Input: className - name of the class to process

 Make HTML files for a single class


 Input: cdi - doc info for class to process

 It makes an index files
 by default makes an index of all classes (if filter="*")
 To generate an index for all classes starting with "XX", do
    html.MakeIndex("XX*");

 Make an inheritance tree


 Input: className - name of the class to process

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


 Input: out - output file stream
        c   - single character

 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 characters, writing to out


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

 Explicitly set a decl file name for TClass cl.

 Explicitly set a impl file name for TClass cl.

 Sort strings


 Input: strings - pointer to an array of strings
        type    - sort type
                  values : kCaseInsensitive, kCaseSensitive
                  default: kCaseInsensitive

 Returns a pointer to a new string which is a duplicate
 of the string to which 's1' points.  The space for the
 new string is obtained using the 'new' operator. The new
 string has the length of 'strlen(s1) + n'.

 strips ' ' and tabs from both sides of str

 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 ("" if not a class), %INCFILE% by the header file name as
 given by TClass::GetDeclFileName() and %SRCFILE% by the source file name as
 given by TClass::GetImplFileName() (both "" if not a class).

 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 fOutputDir, 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%, %UPDATE%, and %COPYRIGHT% in the user's file are replaced by 
 their corresponding values (author, lastUpdate, and copyright) before 
 written to out.

 Replace "::" in name by "__"
 Replace "<", ">", " ", ",", "~", "=" in name by "_"