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

Groups > comp.lang.c > #93185

Re: Doxygen

Show all headers | View raw

On 09/ 4/16 01:10 PM, Malcolm McLean wrote:
> On Saturday, September 3, 2016 at 9:34:26 PM UTC+1, Ian Collins wrote:
>> 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!
>>
> How would you set up unit tests for the binary image processing library?
>
> The functions have been tested, of course, but generally I've done it
> by visual inspection of output.

I would have used a mixture of unit tests for the code (it would have 
been written with TDD) and something like expect as for user acceptance 
tests.  I ran a project a while back where we had an embedded display 
and our testers used expect with reference bitmaps for acceptance testing.

-- 
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