Managed C++/CLI documentation - doxygen/javadoc-like tagged comments ?

  • Thread starter Thread starter Ivan Vecerina
  • Start date Start date
I

Ivan Vecerina

What tagged comment syntax do you use to document C++/CLI code ?

As far as I know, doxygen does not currently support C++/CLI.
Are there other/similar tools?
Does Microsoft provide an equivalent solution?
(the more XML-like syntax used in C#?)

Thanks -Ivan
 
Ivan said:
What tagged comment syntax do you use to document C++/CLI code ?

As far as I know, doxygen does not currently support C++/CLI.
Are there other/similar tools?
Does Microsoft provide an equivalent solution?
(the more XML-like syntax used in C#?)
Click to expand...

You can use C#-style xml comments in C++ as well. See the /doc command line
option for the C++ compiler. I'm not sure what tools you'd use to process
the output. I don't think NDoc can handle it (and I've heard several times
that NDoc has been abandoned by it's creators). There's a new documenter
known as "Sand castle" that MSFT is working on - I think it's on gotdotnet
or something - try a quick Google search and I'm sure you'll find it.

-cd
 
:
: : > Ivan Vecerina wrote:
: >
: >> As far as I know, doxygen does not currently support C++/CLI.
:
: I've developed patches to doxygen for C++/CLI. I e-mailed them to the
: developer before with no response, so yesterday I submitted them as a
bug
: report.
:
: http://bugzilla.gnome.org/show_bug.cgi?id=364536
: http://bugzilla.gnome.org/show_bug.cgi?id=364541

This is great.
Not sure this is appropriate, but I added a comment to support
the importance of this patch. I hope it will be integrated...

Best regards,
Ivan
 
Ivan Vecerina said:
:
: : > Ivan Vecerina wrote:
: >
: >> As far as I know, doxygen does not currently support C++/CLI.
:
: I've developed patches to doxygen for C++/CLI. I e-mailed them to the
: developer before with no response, so yesterday I submitted them as a
bug
: report.
:
: http://bugzilla.gnome.org/show_bug.cgi?id=364536
: http://bugzilla.gnome.org/show_bug.cgi?id=364541

This is great.
Not sure this is appropriate, but I added a comment to support
the importance of this patch. I hope it will be integrated...
Click to expand...

Well Dimitri has accepted two of my patches already, although much smaller
and not related to C++/CLI. I'm pretty hopeful though, seeing that C# is
partially supported there obviously in interest in .NET, and these patches
additionally improve treatment of ANSI C++ keywords such as static_cast.

Will you be able to recompile doxygen yourself to use the patches?
 
message
: : > : > : I've developed patches to doxygen for C++/CLI. I e-mailed them to
the
: > : developer before with no response, so yesterday I submitted them
as a
: > : bug report.
: > :
: > : http://bugzilla.gnome.org/show_bug.cgi?id=364536
: > : http://bugzilla.gnome.org/show_bug.cgi?id=364541
: >
: > This is great.
: > Not sure this is appropriate, but I added a comment to support
: > the importance of this patch. I hope it will be integrated...
:
: Well Dimitri has accepted two of my patches already, although much
smaller
: and not related to C++/CLI. I'm pretty hopeful though, seeing that C#
is
: partially supported there obviously in interest in .NET, and these
patches
: additionally improve treatment of ANSI C++ keywords such as
static_cast.
:
: Will you be able to recompile doxygen yourself to use the patches?

I believe I would be able.
But right now I am in an early (rush) phase of a project, and it is
more a matter for me to decide/choose which documentation approach
to use. The choice of C++/CLI (mainly to be able to replace the
antiquated MFC with the more convenient/modern/supported Forms) is
itself still being debated...
As I have come to rely on doxygen in my other (pure) C++ projects,
I'm very happy to know that support for C++/CLI is happening.
But (regretfully) it is still early for me to build & test these
improvements...

I will keep an eye on this though...
 
Back
Top