Re: Doxygen Code Documentation

2015-09-01 Thread Matt Graham
Thanks for responding so quickly guys! FYI John, I’m not planning on commenting line by line - just commenting all the methods/variables/structures so that people can see how things interact whilst browsing doxygen pages. I’ll try to get around to reading your recommended book, but it

Re: Doxygen Code Documentation

2015-09-01 Thread John Ralls
> On Sep 1, 2015, at 1:43 AM, Matt Graham wrote: > > Thanks for responding so quickly guys! > > FYI John, I’m not planning on commenting line by line - just commenting all > the methods/variables/structures so that people can see how things interact > whilst

Re: Doxygen Code Documentation

2015-08-31 Thread Derek Atkins
Hi, Matt Graham writes: > G’day all! > > > Whilst there is lot of enthusiasm about documentation flowing around, > I thought I’d ask a general question regarding the last type of > documentation not previously mentioned: The doxygen generated > documentation about

Re: Doxygen Code Documentation

2015-08-31 Thread Derek Atkins
John Ralls writes: > Some programmers, often less-experienced ones, will comment code > liberally to explain what they’re doing. More experienced programmers > often find this irritating because they’re fluent enough in the > programming language that they can understand the

Doxygen Code Documentation

2015-08-31 Thread Matt Graham
G’day all! Whilst there is lot of enthusiasm about documentation flowing around, I thought I’d ask a general question regarding the last type of documentation not previously mentioned: The doxygen generated documentation about how the code works (can I call it the API?). I’ve been taking

Re: Doxygen Code Documentation

2015-08-31 Thread John Ralls
> On Aug 31, 2015, at 3:44 AM, Matt Graham wrote: > > G’day all! > > > Whilst there is lot of enthusiasm about documentation flowing around, I > thought I’d ask a general question regarding the last type of documentation > not previously mentioned: The doxygen