Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.c > #93171

Re: Doxygen

Path csiph.com!fu-berlin.de!uni-berlin.de!individual.net!not-for-mail
From Ian Collins <ian-news@hotmail.com>
Newsgroups comp.lang.c
Subject Re: Doxygen
Date Sun, 4 Sep 2016 08:34:17 +1200
Lines 32
Message-ID <e30qe9Fa6mtU1@mid.individual.net> (permalink)
References <e4f25064-cfc4-44e9-a762-d9c5905b6fd2@googlegroups.com> <nqf5l7$dvb$1@gioia.aioe.org>
Mime-Version 1.0
Content-Type text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding 7bit
X-Trace individual.net L8t2oGFpXi99YcaqE95X7AGwNafe7aobF7M2ekRYCSB/Q6BKHO
Cancel-Lock sha1:5pyB6OQsaEsMnW6GcMwhyzVCT+I=
User-Agent Mozilla/5.0 (X11; SunOS i86pc; rv:38.0) Gecko/20100101 Thunderbird/38.5.1
In-Reply-To <nqf5l7$dvb$1@gioia.aioe.org>
Xref csiph.com comp.lang.c:93171

Show key headers only | View raw

On 09/ 4/16 06:43 AM, Randy Howard wrote:
> On 9/3/16 6:13 AM, Malcolm McLean wrote:
>> I've been experimenting with Doxygen.
>>
>> It's produced a nice doc for my binary image library
>>
>> http://malcolmmclean.github.io/binaryimagelibrary/
>>
>> Anyone else had any good or bad experiences with it?
>>
>
> It's rather amazing just how poor Doxygen is, given that is
> often portrayed as the best of such tools.
>
> It's a difficult thing to automate docs in such a way that
> produces good results, stays current and correct with code
> changes, and doesn't make the source look horrific.
>
> Unfortunately, doxygen doesn't really address any of those
> desires well. That said, nothing else does either, except
> manual labor.

Unit tests are the only documentation guaranteed to stay current and 
correct with code changes.

> It's a real problem, and one that doesn't seem
> to interest people enough to do well.

With unit tests, you don't get to choose!

-- 
Ian

Back to comp.lang.c | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

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