discuss-gnustep
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Doxygen documentation


From: Richard Frith-Macdonald
Subject: Re: Doxygen documentation
Date: Tue, 20 Sep 2011 10:20:57 +0100

On 20 Sep 2011, at 09:58, David Chisnall wrote:

> Unfortunately, the output from doxygen is pretty horrible for Objective-C.
> 
> You might like to take a look at the DocGenerator that Quentin wrote, in 
> Étoilé svn.  It uses simpler markup and produces much nicer output.

But the point of using doxygen is that it's supposed to be an improvement ... 
if it's really 'horrible' then we should stick with autogsdoc and just tweak 
the output to look like whatever we want.
A big part of the point of having autogsdoc was to avoid any external 
dependencies so any gnustep code could guarantee it was always available to 
generate documentation ... if we lose that advantage then we want a big 
corresponding advantage somewhere else to compensate.  Now if most people are 
familiar with doxygen and it's easy to use and produces great output, then that 
familiarity/ease of use could be the compensating advantage, but if it's 
complicated and 'horrible' then why bother?


reply via email to

[Prev in Thread] Current Thread [Next in Thread]