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

Groups > comp.lang.c > #93154

Re: Doxygen

Show all headers | View raw

On 03/09/16 16:51, Richard Heathfield wrote:
> On 03/09/16 12:13, 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/
>
> That's a fairly typical Doxymented project.
>
>> Anyone else had any good or bad experiences with it?
>
> The most important thing about Doxygen output is to think of it as an
> adjunct to the documentation, not a replacement for it.
>

You can use Doxygen to make a more complete documentation for your code, 
and it can be quite a good way to make structured documentation 
available in a variety of formats.  But the key point to good Doxygen 
use is to get a suitable balance between documentation and code in the 
code files - and put the larger bits of documentation in separate files. 
  The worst thing you can do with Doxygen is to have headers with dozens 
of lines of Doxygen comments for every couple of lines of declaration. 
If the comments get in the way of reading and understanding the code, 
there are too many and they should be in separate files.

But it is fine for those files to be processed through Doxygen.


Also, for a library it is usual for the Doxygen comments to go mainly in 
the header, not the source files.  Users of the library want to know how 
to use it - they care little for how it is implemented.

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