gEDA-dev: [PATCH] gschem: clean up i_basic.c

[Peter TB Brett]

On Tuesday 29 May 2007 18:39:00 Ivan Stankovic wrote:
> On Tue, May 29, 2007 at 05:59:13PM +0100, Peter TB Brett wrote:
> > Firstly, while you're working on this code could you please take the
> > opportunity to flesh out the Doxygen comments with \param and \returns
> > tags? It does make a lot of difference when tracing what code is supposed
> > to do.
>
> Here is a new version with some doxygen comments added. There are still
> 2 or 3 functions that need better documentation, but I suppose this is
> good enough.

Hi Ivan, looks much better.

I'm afraid I have some more nits -- sorry -- the text in the \brief is **not** 
shown in the main function entry when the documentation is compiled.  So you 
need a short description in the \brief bit, and a longer description in the 
next paragraph (for most of the gEDA documentation, it's in a paragraph 
called "Function Description").

Sorry about being pedantic -- once you get the hang of how they're done, it's 
quite quick to get the docs written, but it is a hassle the first couple of 
times.

Keep up the good work,

Peter

-- 
Fisher Society                              http://tinyurl.com/o39w2
CU Small-Bore Club                          http://tinyurl.com/mwrc9

      09f911029d74e35bd84156c5635688c0            peter-b.co.uk
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://www.seul.org/pipermail/geda-dev/attachments/20070529/770ed18f/attachment.pgp