Class description in automatic documentation

From: Nick van Eijndhoven (Nick@phys.uu.nl)
Date: Mon Oct 11 1999 - 14:39:39 MEST


Dear friends,
Since a class header file gives a very nice and compact overview
of the functionalities of a certain class, I find it rather
convenient to have also the class description within the header file.
Following the examples of the THtml class, I can only get a class description
in my automatically created doc files when I have the text in the source file.
Is there a way to tell Root that the class description is to be taken from
the header file ? If not, could then a new memberfunction be added to
THtml, for instance THtml::SetDescriptionFile("header") where the
default would then be "source" to reflect the current situation.
Another option would be to automatically search the .h file for a class
description if there is none available in the source file.
The latter would even be preferable, since it allows both formats to
coexist within a certain environment. 

                                                  Cheers,
                                                   Nick.




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