On Mon, 23 May 2005 17:00:25 +0200
Christian Biere wrote:
> > o core/extensions.c
> >
> > - * The <headlen> part is simply <len> - <paylen> so it is not stored.
> > + * The \<headlen\> part is simply \<len\> - \<paylen\> so it is not
> > stored.
>
> Sorry, but I think that turns the comments into an ugly unreadable mess.
> The '<' and '>' are there to imply that "headlen" is a variable and
> to be replace with the actual value. It explains the format. Adding the
> backslashes would be misleading in my opinion. Maybe we can rather
> replace '<' and '>' by characters that do not clash with doxygen.
I'd think '\' brings ugliness too, it might be okay these keep as is,
since there's no fatal error.
> > And what I'd like to hear is how to treat initial comment box, i.e.
> > there're some duplications between actual initial box
>
> > * Copyright (c) 2002-2003, Raphael Manfredi
>
> Well, this is a copyright statement.
>
> > * @author Raphael Manfredi
> > * @date 2002-2003
>
> This isn't. You'd need a lawyer to figure out whether this matters
> and to what extent.
I'd rather mind
* Copyright (c) 2002-2003, Raphael Manfredi
*
* Download mesh. <- this one
* Download mesh. <- this one
*
* @author Raphael Manfredi
those short description (sometimes it's including detailed description),
because in STYLE, it says as follows
* $Id: STYLE,v 1.18 2005/04/23 05:40:26 cbiere Exp $
*
* Copyright (c) [year], [name of the author]
*
*--...
/**
* @file
*
* [general description of the file contents]
*/
> > By the way, is there any possibility these generated HTML files are
> > hosted at http://gtk-gnutella.sourceforge.net/ somewhere?
>
> You mean like http://gtk-gnutella.sf.net/doxygen/ ?
Yes if possible, further auto-generating (always up-to-date).
--
Daichi
-------------------------------------------------------
This SF.Net email is sponsored by Oracle Space Sweepstakes
Want to be the first software developer in space?
Enter now for the Oracle Space Sweepstakes!
http://ads.osdn.com/?ad_id=7412&alloc_id=16344&op=click
_______________________________________________
Gtk-gnutella-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gtk-gnutella-devel
