Re: Auto document generation

From: Valeri Fine (Faine) (fine@bnl.gov)
Date: Mon Oct 11 1999 - 01:17:57 MEST


COne can create his /her own "entry"

  TClass header1("table_head_st",1,"table_header.h","table_header.h");
----- Original Message ----- 
From: Fred Gray <fegray@uiuc.edu>
To: Matt Dobbs <Matthew.Adam.Dobbs@cern.ch>
Cc: <roottalk@hpsalo.cern.ch>
Subject: Re: Auto document generation


> Matt Dobbs wrote:
> > I like ROOT's automatic document generation- I'd like to use it to
> > generate html pages for:
> >
> > - generic C++ code that doesn't have a ClassImp or ClassDef call
> > - classes under development that only have .h files. This way I can write
> >   the .h file for a class, then refer to the nicely formatted html pages
> >   as I do the coding for the guts of the class.

  ClassDef / ClassImp do define one extra global object for the each instance of the
  class. That one can create "by hand" on its own (for example to create HTML for the plain 
  header files of the plain C-struct's) as follows:

  TClass header1("table_head_st",1,"table_header.h","table_header.h");

  The statement above does the job for THtml, "ClassDef" does.

                    Hope this helps.
                                                  Valery

> 
> Matt, 
> 
> THtml seems to be tightly connected to ROOT's run-time type
> information system, so I suspect that this would be difficult to 
> do.  However, there is a tool out there called Doc++ that 
> produces HTML and LaTeX documentation for arbitrary C, C++, and Java
> code.  You might want to look into it:
> 
> http://www.zib.de/Visual/software/doc++/Introduction.html

  I've looked this page up but didn't get whether they may parse any comment to 
  replace all class names with hyperlinks to these class documentation ?
  It is one of the main advantage of the ROOT HTML. It may find and replace with hyperlink
  any word if that present in its dictionary.

> 
> -- Fred
> 



This archive was generated by hypermail 2b29 : Tue Jan 04 2000 - 00:43:40 MET