Creating Documentation on Your Own Classes via ROOT.

First of all there is ROOT HOWTO's pages and ROOT Tutorials on subject and
related issues:

Below is description of my own experience:

After WAT's classes were added to ROOT successfully I created simple macro html_doc.C which will generate documentation on WAT classes in HTML format:

html_doc.C:

{
   gSystem.Load("wavelet.so");

   THtml html;

   html.SetOutputDir("./html");
   html.SetSourceDir( "./");
   html.MakeClass("Wavelet");
   html.MakeClass("WaveData");
   html.MakeClass("WaveDataTD");
   html.MakeClass("WaveDataWD");
   html.MakeClass("WaveTool");
   html.MakeClass("WaveLifting");
   html.MakeClass("WaveLiftingBiort");
   html.MakeClass("WaveLiftingBiortInt");
   html.MakeClass("WaveDataZ");
   html.MakeIndex();

   return;
}

This macro calls function THtml::MakeClass() for all WAT's classes, then call function THtml::MakeIndex(), generated HTML and PostScript files will go to the directory ./html.

Then I added to Makefile the command to run this macro in batch mode:

root -b -n -q -l html_doc.C

For automatic document generation feature of ROOT to work the comments embedded in your code should conform to some rules:

http://root.cern.ch/root/Conventions.html .

Last update: May 25, 2000
Andrei Sazonov