Date: Fri, 19 May 2006 06:14:58 -0500 (CDT) From: Sergey Babkin <babkin@verizon.net> To: Warner Losh <imp@bsdimp.com>, phk@phk.freebsd.dk Cc: src-committers@FreeBSD.org, cvs-src@FreeBSD.org, gnn@neville-neil.com, cvs-all@FreeBSD.org, julian@elischer.org, hellmuth.michaelis@t-online.de Subject: Re: Re: cvs commit: src Makefile.inc1 ObsoleteFiles.inc src/etc/defaults rc.conf Message-ID: <16489295.8854801148037298444.JavaMail.root@vms168.mailsrvcs.net>
next in thread | raw e-mail | index | archive | help
>From: Warner Losh <imp@bsdimp.com> >> In message <20060518.122122.71180479.imp@bsdimp.com>, Warner Losh writes: >> >> >> I've not been very impressed with what I've seen from sources using >> >> this approach, but I guess having the prototypes with one line >> >> comments is better than nothing. >> > >> >Doxygen does more than one line, and you get out of it the effort that >> >you put into it as far as quality goes. >> >> That was sort of what I hinted at: most places I've seen don't seem >> to have the follow-through to actually get more than the prototypes >> out. > >Yes. It takes everyone pulling together to make it work. Doxygen is definitely beffer than nothing but not a replacement for proper man pages either. I've had experience with this kind of documentation in Qt, and it gives some idea of what is happening inside the function but always leaves enough mystery. The part that is missing is the big picture of how these functions are intended to work together. -SB
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?16489295.8854801148037298444.JavaMail.root>