Why Samba development is hard
kai at samba.org
Mon Mar 3 20:35:06 GMT 2008
On Sunday 02 March 2008 10:03:29 Brad Hards wrote:
> I don't have any real suggestions for nonexistent, but you can do automated
> checks for out-of-date Doxygen comments. KDE does a range of checks,
> including API documentation:
> which allows you to "drill down" to get reports like:
> The source code for that is available at:
It's a sad irony that the tools to make sure code is well-documented have a
really crappy documentation.
Still, I like the system and will dig into that a bit, even though it's
written in perl.
> If Samba is serious about API documentation, perhaps there should be some
> kind of policy (even "please add API docs when you add new methods for ldb,
> talloc and tdb"). Although KDE focuses on C++ class docs, possibly
> something like the KDE one might be useful:
Yeah, we probably could put something like that into the wiki. Comments?
> Of course, that doesn't get you any real design overview (which you can do
> in Doxygen, see
>html for an example). At some point you'll just have to read the code, but
> even pasting bits of email or IRC conversations into a Doxygen comment
> block might be useful to get started.
True. This week's going to be a bit crazy, but maybe I can look into this
while on the train on Wednesday.
WorldForge developer http://www.worldforge.org/
Wine developer http://wiki.winehq.org/KaiBlin
Samba team member http://www.samba.org/samba/team/
Will code for cotton.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Size: 189 bytes
Desc: This is a digitally signed message part.
Url : http://lists.samba.org/archive/samba-technical/attachments/20080303/d781bd60/attachment.bin
More information about the samba-technical