Re: [PATCH] Doxygenate defs.h

[Stan Shebs <stanshebs@earthlink.net>]

On 2/17/14 1:57 PM, Stan Shebs wrote:
> This is a first patch that modifies source code to be more useful with
> Doxygen.  It does little more than add an extra "*" to comment blocks
> that document the source construct immediately following.
> 
> In keeping with our usual practice, I have not changed anything outside
> comments, and the comments themselves are only minimally tweaked,
> despite the great temptation to expand on some of the more cryptic. :-)
> 
> I'll push this in a couple days if people are willing to live with this
> format for comments.  Next up, minsyms.h.
> 
> Stan
> stan@codesourcery.com
> 
> 2014-02-17  Stan Shebs  <stan@codesourcery.com>
> 
> 	* defs.h: Annotate comments for Doxygen.
> 

This is now pushed.  While I recognize that this direction is not
unanimously popular, I think this is something we need to try;
as always, we can back it all out a year from now if we are not finding
it helpful.

Stan
stan@codesourcery.com