Hi,

on a side note: There is Doxygen support available for OpenOBEX now.  
Here are some basic conversion hints:

Functions are preceded with something like
/**
        Brief description.
        \param foobar some explanation
        \return description of the result
  */

In summary this means adding a full stop to the first line and turning  
every @foobar int \param foobar.
The indentation here is a single tab for brevity and looks.

Variables and types can be preceded with a single line of /** some doc  
*/

E.g. see http://dev.zuckschwerdt.org/openobex/browser/trunk/lib/obex.c  
and 
http://dev.zuckschwerdt.org/openobex/browser/trunk/include/openobex/obex_const.h

This enables e.g. http://dev.zuckschwerdt.org/openobex/doxygen/ esp. 
http://dev.zuckschwerdt.org/openobex/doxygen/html//obex_8c.html

The full changeset is here http://dev.zuckschwerdt.org/openobex/changeset/321

If there is some interest in this, I can draw up a style guide and  
open it for discussion.

regards,
Christian

Am 03.06.2008 um 13:36 schrieb Johan Hedberg:

> the attached patch for a new OBEX_ObjectGetSpace function

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Openobex-users mailing list
Openobex-users@lists.sourceforge.net
http://lists.sourceforge.net/lists/listinfo/openobex-users

Reply via email to