[PATCH] Document talloc with doxygen

[Stefan (metze) Metzmacher]

Rusty Russell schrieb:
> On Fri, 29 Jan 2010 12:50:05 pm tridge at samba.org wrote:
>> Hi Andreas,
>>
>> Sorry for the slow response!
>>
>>  > You can take a look at the html output at:
>>  >
>>  > http://www.cynapses.org/tmp/samba/talloc/
>>
>> that layout is nice, thanks
> ...
>> I'm also not at all sure that having chunks of html in a .h file is a
>> good idea. It looks like the stuff at the top of talloc.h is just raw
>> html that is then used to build the talloc.samba.org web page. The
>> talloc home page is pretty simple now, but if we want it to grow later
>> we will want release announcements there, news links, tutorials, links
>> to (for example) Rustys talk on talloc at LCA, and it seems a strange
>> idea to be committing all those as comments in a C header file. How do
>> you imagine we'd handle that?
> 
> CCAN has taken a kerneldoc-lite middleground.  Here's the header from
> the CCAN version (this one has some experimental stuff in it, but the
> documentation is pretty good):

Thanks! We need to collect the good documentation pieces from all
locations and combine them into one places.

metze

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 260 bytes
Desc: OpenPGP digital signature
URL: <http://lists.samba.org/pipermail/samba-technical/attachments/20100129/384f39ef/attachment.pgp>