Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
| 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 <gwowen@gmail.com> |
| Newsgroups | comp.lang.c |
| Subject | Re: Doxygen |
| References | <e4f25064-cfc4-44e9-a762-d9c5905b6fd2@googlegroups.com> <nqi71g$h4m$1@dont-email.me> |
| Date | Mon, 05 Sep 2016 06:28:32 +0100 |
| Message-ID | <87mvjmhq4f.fsf@gmail.com> (permalink) |
| 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 |
Show key headers only | View raw
jacobnavia <jacob@jacob.remcomp.fr> 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.
Back to comp.lang.c | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread
Doxygen Malcolm McLean <malcolm.mclean5@btinternet.com> - 2016-09-03 04:13 -0700
Re: Doxygen Richard Heathfield <rjh@cpax.org.uk> - 2016-09-03 15:51 +0100
Re: Doxygen David Brown <david.brown@hesbynett.no> - 2016-09-03 18:25 +0200
Re: Doxygen Randy Howard <rhoward.mx@EverybodyUsesIt.com> - 2016-09-03 13:43 -0500
Re: Doxygen Ian Collins <ian-news@hotmail.com> - 2016-09-04 08:34 +1200
Re: Doxygen Malcolm McLean <malcolm.mclean5@btinternet.com> - 2016-09-03 18:10 -0700
Re: Doxygen Ian Collins <ian-news@hotmail.com> - 2016-09-04 13:41 +1200
Re: Doxygen Gareth Owen <gwowen@gmail.com> - 2016-09-04 09:05 +0100
Re: Doxygen Tim Rentsch <txr@alumni.caltech.edu> - 2016-09-04 14:39 -0700
Re: Doxygen jacobnavia <jacob@jacob.remcomp.fr> - 2016-09-05 00:25 +0200
Re: Doxygen Gareth Owen <gwowen@gmail.com> - 2016-09-05 06:28 +0100
Re: Doxygen Gareth Owen <gwowen@gmail.com> - 2016-09-05 07:00 +0100
Re: Doxygen David Brown <david.brown@hesbynett.no> - 2016-09-05 09:07 +0200
Re: Doxygen Malcolm McLean <malcolm.mclean5@btinternet.com> - 2016-09-05 00:26 -0700
Re: Doxygen David Brown <david.brown@hesbynett.no> - 2016-09-05 10:51 +0200
Doxygen "Rick C. Hodgin" <rick.c.hodgin@gmail.com> - 2016-09-04 17:29 -0700
csiph-web