API docs; functional or pretty?

[Carsten Niehaus]

Am Sonntag 25 Juni 2006 16:55 schrieb Adriaan de Groot:
> Yes, writing better docs with good overviews, meaningful mainpages and
> grouping classes together to give a better (finer-grained that
> per-directory) logical structure to the API is an important issue. I'm a
> big fan of @ingroup, @{, @section and all that, but I'm <snip>...

Yes, OpenBabel2 is using this notation and it is really really good!

//! \name Methods which are really cool
//@{

//! Cool method
void cool();
//! Even cooler method
void cooler();

//@}

For an example, please have a look here:

http://openbabel.sourceforge.net/api/classOpenBabel_1_1OBMol.shtml#400c1ca5057984dd7e6b1a92be27c441

And search for 
	"Initialization and data (re)size methods"



-- 
Gruß,
  Carsten Niehaus
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 191 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kde-core-devel/attachments/20060625/7a0698e2/attachment.sig>