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

Groups > comp.lang.c++ > #7471 > unrolled thread

Documenting C++ Code

Back to article view | Back to comp.lang.c++

Contents

  Documenting C++ Code Joseph Hesse <joeh@gmail.com> - 2011-07-05 08:52 -0500
    Re: Documenting C++ Code "Balog Pal" <pasa@lib.hu> - 2011-07-05 16:18 +0200
    Re: Documenting C++ Code Björn Voß <bjoern.voss@iwr.uni-heidelberg.de> - 2011-07-05 16:18 +0200
    Re: Documenting C++ Code Andrea Venturoli <ml.diespammer@netfence.it> - 2011-07-05 21:52 +0200
      Re: Documenting C++ Code Dombo <dombo@disposable.invalid> - 2011-07-05 22:17 +0200
      Re: Documenting C++ Code "Ira Baxter" <idbaxter@semdesigns.com> - 2011-07-06 19:43 -0500
        Re: Documenting C++ Code Andrea Venturoli <ml.diespammer@netfence.it> - 2011-07-07 17:40 +0200
    Re: Documenting C++ Code Ian Collins <ian-news@hotmail.com> - 2011-07-06 08:51 +1200
      Re: Documenting C++ Code "MikeP" <mp011011@some.org> - 2011-07-07 16:10 -0500
    Re: Documenting C++ Code Qi <no@no.no> - 2011-07-06 10:07 +0800
      Re: Documenting C++ Code Stuart Redmann <DerTopper@web.de> - 2011-07-05 22:38 -0700

#7471 — Documenting C++ Code

I am looking at tools to document C++ code and extract the documentation 
to a text or html file.

So far I have looked at doxygen and autodoc.

I would like to know what documentation tools you have had success with.

Thank you,
Joe

[toc] | [next] | [standalone]

#7472

"Joseph Hesse" <joeh@gmail.com> 
>I am looking at tools to document C++ code and extract the documentation 
> to a text or html file.
> 
> So far I have looked at doxygen and autodoc.
> 
> I would like to know what documentation tools you have had success with.

Doxygen.  Good stuff.

[toc] | [prev] | [next] | [standalone]

#7473

Hi Joe,

im working with a library that provides a documentation generated with
doxygen.

http://hci.iwr.uni-heidelberg.de/vigra/

There you can also see how you have to comment you code to make it
Doxygen compatible.

Greetings

Björn

Am 05.07.2011 15:52, schrieb Joseph Hesse:
> I am looking at tools to document C++ code and extract the documentation
> to a text or html file.
> 
> So far I have looked at doxygen and autodoc.
> 
> I would like to know what documentation tools you have had success with.
> 
> Thank you,
> Joe

[toc] | [prev] | [next] | [standalone]

#7495

On 07/05/11 15:52, Joseph Hesse wrote:
> I am looking at tools to document C++ code and extract the documentation
> to a text or html file.
>
> So far I have looked at doxygen and autodoc.
>
> I would like to know what documentation tools you have had success with.
>
> Thank you,
> Joe

I'm quite happy with Doxygen.
I only wish it was smarter with templates...

  bye
	av.

[toc] | [prev] | [next] | [standalone]

#7496

Op 05-Jul-11 21:52, Andrea Venturoli schreef:
> On 07/05/11 15:52, Joseph Hesse wrote:
>> I am looking at tools to document C++ code and extract the documentation
>> to a text or html file.
>>
>> So far I have looked at doxygen and autodoc.
>>
>> I would like to know what documentation tools you have had success with.
>>
>> Thank you,
>> Joe
>
> I'm quite happy with Doxygen.
> I only wish it was smarter with templates...

...and constructors and operator overloading. When you use smart 
pointers the 'referenced by' sections are not very useful with Doxygen.

Otherwise I'm quite happy with it. Doxygen is one of the first things I 
use when getting on to grips with a unfamiliar code base (which are more 
often than not poorly documented if at all).

[toc] | [prev] | [next] | [standalone]

#7558

"Andrea Venturoli" <ml.diespammer@netfence.it> wrote in message 
news:iuvq27$ik2$1@speranza.aioe.org...
> On 07/05/11 15:52, Joseph Hesse wrote:
>> I am looking at tools to document C++ code and extract the documentation
>> to a text or html file.
>>
>> So far I have looked at doxygen and autodoc.
>>
>> I would like to know what documentation tools you have had success with.
>>
>> Thank you,
>> Joe
>
> I'm quite happy with Doxygen.
> I only wish it was smarter with templates...

I don't understand why people love Doxygen fior C++.
It doesn't  do lookups correctly.
(I'd guess this is because it really doesn't have a C++ parser).

Take this example:

---------------------------------

class A {
    public: void foo() {}
}

int main() {
   A *a;
   a->foo(); // doxygen can find foo
   (a) -> foo(); // doxygen can't find foo
   (*a) .foo(); // doxygen can't find foo
}

-----------------------------------------

So, it gets a 9 line example wrong.  How can you trust with 100K SLOC?


-- 
Ira Baxter, CTO
www.semanticdesigns.com 

[toc] | [prev] | [next] | [standalone]

#7583

On 07/07/11 02:43, Ira Baxter wrote:

> I don't understand why people love Doxygen fior C++.
> It doesn't  do lookups correctly.
> (I'd guess this is because it really doesn't have a C++ parser).

It's not a matter of hate or love; it all comes down to need and use.
If you can suggest a better alternative, I'll be glad to try it.

  bye & Thanks
	av.

[toc] | [prev] | [next] | [standalone]

#7497

On 07/ 6/11 01:52 AM, Joseph Hesse wrote:
> I am looking at tools to document C++ code and extract the documentation
> to a text or html file.
>
> So far I have looked at doxygen and autodoc.
>
> I would like to know what documentation tools you have had success with.

Requirements and unit tests.  If you need anything else, you are doing 
something wrong!

-- 
Ian Collins

[toc] | [prev] | [next] | [standalone]

#7606

Ian Collins wrote:
> On 07/ 6/11 01:52 AM, Joseph Hesse wrote:
>> I am looking at tools to document C++ code and extract the
>> documentation to a text or html file.
>>
>> So far I have looked at doxygen and autodoc.
>>
>> I would like to know what documentation tools you have had success
>> with.
>
> Requirements and unit tests.  If you need anything else, you are doing
> something wrong!

 Not true. From requirements (should) come architecture and design and 
implementation plan, in some "physical" form (for all but the most 
hackish projects). Those precursory deliverables are the high-level view 
into the implementation. Guaranteed project failure: bring on the 
programmers before doing any architecting, engineering, designing, 
planning.

That said, for understanding CodeMess (and most code is such), I use 
Doxygen. 

[toc] | [prev] | [next] | [standalone]

#7505

On 2011-7-5 21:52, Joseph Hesse wrote:
>
> I would like to know what documentation tools you have had success with.

+1 Doxygen


-- 
WQ

[toc] | [prev] | [next] | [standalone]

#7509

On 6 Jul., 04:07, Qi <n...@no.no> wrote:
> On 2011-7-5 21:52, Joseph Hesse wrote:
>
>
>
> > I would like to know what documentation tools you have had success with.
>
> +1 Doxygen

+1 Doxygen
------------
running total: 2  ;-)

Stuart

[toc] | [prev] | [standalone]

Back to top | Article view | comp.lang.c++

csiph-web