Hi Pasha, Walter,
Thanks for initiating this interesting discussion about HTML generation.
The THtml class was developped (mainly by Nenad Buncic) when we started
the Root project. At this time, not much existed in this area and we had
to do a lot of prototyping to understand the main requirements.
Unfortunately, when Nenad left we did not have the necessary manpower
to continue the necessary developments requested by many users for this
class. It is only very recently that Philippe Canal and Peter Malzacher
have started to look again in THtml to correct a few bugs and implement
new features.
I personally agree with your comments and requests. I have the following
observations.
- It is important to provide
--the class summary with extraction of the few comments describing
each member function.
--the full code instrumented
-- cros-references between the two
- possibility to embed html comments in the code including pictures.
- I agree with Pasha that the inheritance tree in ps format is not
the most interesting format. In version 2.23, the class TClassTree
produces a graphical view of the class relationships. I could extend
this class to generate the html picking facility to support the nice
feature reported by Walter in Doxygen.
When running THtml, a gif file showing the class relations could be
automatically inserted in the documentation.
- I agree with Pasha that one should be able to support a class with
multiple implementation files. In the case of Root, this could be
implemented by allowing a ClassImp in each implementation file.
The Root Meta dictionary will keep trace of all the files.
- The look&feel of the generated html should be upgraded to import
the nice features found in the other systems.
- Root THtml already supports a directory search path for the source.
This requires some extensions in case of multiple levels.
Until now, one must run Root to execute the THtml class. It was our
intention to provide a small utility roothtml (like rootcint) to
generate
html files for classes not instrumented for Root.
An extension of THtml should be made in view of the XML standard.
>From the XML files, one should be able to generate the html files
but also Latex (or equivalent) with tables of contents and index.
This is useful to automatize the generation of printed documents.
I strongly encourage users to continue this discussion with additional
suggestions and comments.
Rene Brun
Pasha Murat wrote:
>
> hi - I looked at the URL you mentioned - the docs look pretty nice!
>
> just a couple of quick comments:
>
> - in what it calls "TH1 Class Reference" doxygen doesn't distinguish
> between the functions and the data members which sort of inconvenient
> it would really be nice to see the functions and the data members
> separately - how difficult this would be?
>
> - I then looked at what is called "File reference" - example is given by
>
> http://www-kp3.gsi.de/www/dox/root_raw_dev/html/H_H2.cxx.html
>
> why does doxygen take all the comments out of what it
> calls "the source file reference"? Is it fixable?
>
> thanks, pasha
This archive was generated by hypermail 2b29 : Tue Jan 04 2000 - 00:43:40 MET