I have always preferred @ myself, just because it is more universal. Also, it looks similar to the xpath @ for 'attribute'.
I really see no reason for people to change from what they are already using. Not altering anyone's style preference has always been a rule with me. A parser or regexp can be written to handle either.
bob
On 10/5/2008 10:00 AM, J.B.C.Engelen@...1578... wrote:
-----Original Message----- From: Jon A. Cruz [mailto:jon@...18...] Sent: donderdag 2 oktober 2008 10:24 To: Engelen, J.B.C. (Johan) Cc: inkscape-devel@lists.sourceforge.net; lib2geom-devel@lists.sourceforge.net Subject: Re: [Lib2geom-devel] [Inkscape-devel] documentation effort
On Oct 1, 2008, at 3:41 PM, J.B.C.Engelen@...1578... wrote:
Note 4: Doxygen accepts two command styles: \pre and @pre. They can be
mingled without a problem I think, but shall we try to use the slash?
\file, \brief, etc.
The main point of the "@" format is to be compatible with JavaDoc, which was the main thing to push such doc comments.
One factor for using the "@" form is to allow for different tools to be used in addition to Doxygen.
Another factor is to allow developers working on Java code to use a consistent format across source file types.
The main reason I proposed to use slashes is because I have not found use of @ for doxygen commands. (2geom already has a quite some doxygen text). So conversion to use the @ would be quite a bit of work.
MySQL insists on using '@' but does not give a reason (and I can't find one in doxygen's manual).
One factor for using the "@" form is to allow for different tools to be used in addition to Doxygen.
Do you mean tools for adding comments in doxygen format?
I am undecided on this one, just that '' saves us from converting stuff and is what current 2geom coders have been doing.
Johan
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK& win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Inkscape-devel mailing list Inkscape-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-devel