Path: csiph.com!news.mixmin.net!border2.nntp.ams1.giganews.com!nntp.giganews.com!buffer1.nntp.ams1.giganews.com!nntp.brightview.co.uk!news.brightview.co.uk.POSTED!not-for-mail NNTP-Posting-Date: Mon, 05 Sep 2016 00:28:33 -0500 From: Gareth Owen Newsgroups: comp.lang.c Subject: Re: Doxygen References: Date: Mon, 05 Sep 2016 06:28:32 +0100 Message-ID: <87mvjmhq4f.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (gnu/linux) Cancel-Lock: sha1:+iKP00taweVzJPyhfTXa2FYkCtw= MIME-Version: 1.0 Content-Type: text/plain Lines: 18 X-Usenet-Provider: http://www.giganews.com X-Trace: sv3-m5VeUHvhBq55+B2+2WpYN3btIpHw+2jjJtpul52C0OePKO3AcHAeRUvTNVrH3T70IjzDz/6KIaZBIBh!E7qXa+St8EVAI0aaGMy64SLPl6Dbl5np1zhyrHDCD5tHwZb4eGOe/AYa9nrxU/CM X-Abuse-and-DMCA-Info: Please be sure to forward a copy of ALL headers X-Abuse-and-DMCA-Info: Otherwise we will be unable to process your complaint properly X-Postfilter: 1.3.40 X-Original-Bytes: 1753 Xref: csiph.com comp.lang.c:93203 jacobnavia writes: > That is no DOCUMENTATION in the sense that doesn't explain anything, > nor does it describe the architecture of the system. You can, of course use Doxygen to generate such documentation, but you still have to write it by hand, which is the major sticking point. > It is just machine generated verbiage that nobody reads. A lot of it, yes. I find @brief, @param and @returns useful, though. More often than note, I just find the discipline to include them in the headers extremely useful. I rarely actually run Doxygen for the HTML; only because it will tell me which functions I haven't documented in this way. It's just a nice, moderately "standard", way to document function parameters, and to check that its done.