Valery wrote:
> Is it ease to use ?
Yes. I'm not claiming that it's particilar easy for ROOT, but the
original question was actually about documenting classes *not*
integrated in ROOT, and for this purpose, there are imho easier
solutions then to bend THtml backwards.
> For example is it trouble for you to apply this packages to
> create ROOT HTML documentation and upload it on some Web site.
No. Simply cooking up a doxygen config file and running it over
*a subset* of the ROOT sources gives you for example
http://www-kp3.gsi.de/www/dox/root_raw/html/class_TH2S.html
In this view I like the navigable class diagram (every yellow field
is a link) and the "List of all members", which tells you all
the members this class has, either directly or by inheritance.
Both of these features I've missed a couple of times in the ROOT
documentation.
Since doxygen expects the documentation marked by some tags one
clearly doesn't see any of the ROOT documentation comments. I've
not yet found the time to hack a PERL script to simply reformat
the ROOT documentation comments into the doxygen style.
However, switching on the yet experimental SOURCE_BROWSER feature
in doxygen adds the code to the documentation, and you get
http://www-kp3.gsi.de/www/dox/root_raw_dev/html/class_TH2S.html
This makes most of the method documentation text visible and gives
an alternative form of ROOT documentation which is for some purposes
easier to navigate.
NOTE: This is not to demonstrate that doxygen is better for ROOT than THtml !!
However, it is to show that there is clearly room for improving
THtml, like by adding a navigable class diagram like doxygen or
a "List of all members".
With best regards, Walter
--
Walter F.J. Mueller Mail: W.F.J.Mueller@gsi.de
GSI, Abteilung KP3 Phone: +49-6159-71-2766
D-64291 Darmstadt FAX: +49-6159-71-2989
WWW: http://www-kp3.gsi.de/www/kp3/people/mueller.html
PGP: http://www-kp3.gsi.de/~mueller/pgp.shtml
This archive was generated by hypermail 2b29 : Tue Jan 04 2000 - 00:43:40 MET