This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: More uses of "fatal"


On Tue, Feb 06, 2001 at 11:26:10AM +0000, Richard Earnshaw wrote:
> > Given the lack of a GCC Developer's Manual, how does the top of diagnostic.h
> > sound to you?
> > 
> 
> Java has the concept of a documentation comment, which just happens to be
> 	/** ... */
> If we adopted this (or something similar) as a convention in gcc, and then 
> put .texi information in such comments in the header files we could soon 
> have a developers manual which was largely auto-generated.

For libstdc++-v3, we had started to use the open-source tool Doxygen to
do this kind of thing for us.  The output is very nice, but setting up
the doxygen config file appears to be a fair bit of work.


Phil

-- 
pedwards at disaster dot jaj dot com  |  pme at sources dot redhat dot com
devphil at several other less interesting addresses in various dot domains
The gods do not protect fools.  Fools are protected by more capable fools.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]