generating HTML docs on the fly

Pasha Murat (murat@cdfsga.fnal.gov)
Fri, 7 Aug 1998 18:07:48 -0500 (CDT)


Hi Rooters,
yesterday Valery Fine taught me a lesson on how to generate HTML
description for a class "on the fly". I didn't find this described in ROOT
howto's, so I'm posting the solution in hope that it could be useful.

Suppose a class A is described by 2 files: A.h and A.cc located in the working
directory:

-------------------------------------------------- A.h
#include "Rtypes.h"

class A {
protected:
int ia; // a data member
public:
A();
virtual ~A();
int Ia() { return ia; }
void SetIa (int i) { ia = i;}
int NonTrivial();
ClassDef(A,1)
};
---------------------------------------------------- A.cc
//_________________________________
// this is a description of A class
#include "A.h"

int A::Nontrivial() {
// the only non-trivial function which is documented here
}
--------------------------------------------------------------

And here is the a sequence of commands to generate HTML doc or this class:

root [0] #pragma includepath /cdf/upgrade/root/v2_00_08/GCC_2_7/include
root [1] #include "A.h"
Warning: Re-initialization ignored const kTRUE FILE:/cdf/upgrade/root/v2_00_08/GCC_2_7/include/Rtypes.h LINE:69
Warning: Re-initialization ignored const kFALSE FILE:/cdf/upgrade/root/v2_00_08/GCC_2_7/include/Rtypes.h LINE:70
root [2] TClass c("A",1,"A.h","A.cc")
root [3] THtml html;
root [4] gHtml->SetOutputDir("./")
root [5] gHtml->SetSourceDir("./")
root [6] gHtml->MakeClass("A")
./A.html
./A_Tree.ps
PostScript file: ./A_Tree.ps has been created

All the thanks go to Valery, Pasha.