[openbeosstorage] Re: Doxygen vote

> I'm voting for concise doxygen comments.

Not keen on, for a start they don't inhertly "wrap" well, I really don't
like like my lines wrapping themselfs.
Plus the extras are left of, so doxgen will not get the params, return
values etc.

My vote would be

Top of each file having

/** One Liner
 * any extra information
 * Blah blah blah...
 *
 * @see <a href="http://open-beos.sf.net/bsd-mit.html";> OpenBeOS license
</a>
 * @auther <a href="mailto:me@xxxxxxxxxxxx";>   Me    </a>
 * @auther <a href="mailto:you@xxxxxxxxxxxx";>  You   </a>
 * @version 1
 */

The fuctions having either your one liner (if nothing else is required) or

/** Onliner
 * Any Extra Info
 *
 * @param Fish The fish you want to check
 * @returns The status of the fish
 * @see fish_stat
 */ 

But then I do like Java's javadoc and end up using it a lot, people should
not be reading the .h files to get info on the class, they should read the
doxgen'ed .html files.

Mike

-- 
Mike Lee [ mlk@xxxxxxxxx ]
"Pulling together is the aim of despotism and tyranny. Free men pull in all
kinds of directions." 
Terry Pratchett, The Truth

GMX - Die Kommunikationsplattform im Internet.
http://www.gmx.net

Other related posts: