473,322 Members | 1,510 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,322 software developers and data experts.

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

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
--
http://ivan.vecerina.com/contact/?subject=NG_POST <- email contact form

Oct 21 '06 #1
6 4829
Ivan Vecerina wrote:
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#?)
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
Oct 23 '06 #2
Ivan Vecerina wrote:
As far as I know, doxygen does not currently support C++/CLI.
Doc-O-Matic does (the Professional and the C++ editions support C++/CLI):
http://www.doc-o-matic.com/featurematrix.html

So far I'm very satisfied with the product, although I haven't used it
with C++/CLI extensively.

Tom
Oct 23 '06 #3

"Tamas Demjen" <td*****@yahoo.comwrote in message
news:uI**************@TK2MSFTNGP05.phx.gbl...
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
>
Doc-O-Matic does (the Professional and the C++ editions support C++/CLI):
http://www.doc-o-matic.com/featurematrix.html

So far I'm very satisfied with the product, although I haven't used it
with C++/CLI extensively.

Tom

Oct 24 '06 #4
"Ben Voigt" <rb*@nospam.nospamwrote in message
news:eM**************@TK2MSFTNGP03.phx.gbl...
:
: "Tamas Demjen" <td*****@yahoo.comwrote in message
: news:uI**************@TK2MSFTNGP05.phx.gbl...
: 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

Oct 25 '06 #5

"Ivan Vecerina" <IN*****************@ivan.vecerina.comwrote in message
news:ev****************@TK2MSFTNGP05.phx.gbl...
"Ben Voigt" <rb*@nospam.nospamwrote in message
news:eM**************@TK2MSFTNGP03.phx.gbl...
:
: "Tamas Demjen" <td*****@yahoo.comwrote in message
: news:uI**************@TK2MSFTNGP05.phx.gbl...
: 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...
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?
>
Best regards,
Ivan

Oct 25 '06 #6
"Ben Voigt" <rb*@nospam.nospamwrote in message
news:eQ****************@TK2MSFTNGP02.phx.gbl...
: "Ivan Vecerina" <IN*****************@ivan.vecerina.comwrote in
message
: news:ev****************@TK2MSFTNGP05.phx.gbl...
: "Ben Voigt" <rb*@nospam.nospamwrote in message
: news:eM**************@TK2MSFTNGP03.phx.gbl...
: : 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...
--
http://ivan.vecerina.com/contact/?subject=NG_POST <- email contact form
Oct 27 '06 #7

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

1
by: Krusty276 | last post by:
I'm getting this error when trying to compile javadoc in ant from my buildxml: Any ideas? C:\umg\java\web\dbtest\WEB-INF\src\build.xml:64: Javadoc failed: java.io.IOException: CreateProcess:...
1
by: Prakash | last post by:
Hi, I want to generate the JDK API using Javadoc. I have installed java 1.4.2 in WINDOWS. Since i don't have frequent access to the Net, i want to generate the Java API Help using javadoc.But I...
3
by: schwehr | last post by:
Done any one have a way (and examples) of how to do math markups in the docstrings of function and class definitions such that the equations get typeset in the generated html documentation? I'll...
5
by: Bob Rundle | last post by:
I've been looking at the XML documentation for C# code. I've put in a number of <summary>, <remarks>, <param> tags and used the /doc switch to create an XML file. What now? I was expecting...
6
by: kpd | last post by:
Hello, I have written a C++ library that I've then wrapped with Pyrex. Any suggestions to the best-in-class tool to create documentation for the libraries? I would love to document things in...
1
by: MiranL | last post by:
Hello, does anybody know which tools are used to create the online-HTML-manual on PHP.net? Thanks, Miran
1
by: Jan Danielsson | last post by:
Hello all, I guess I should really be asking in some doxygen mailing list, but since I believe that I found doxygen through this group, I assume that there are some people here who can answer. ...
2
by: rednarjess | last post by:
Hello every body; When I want to generate the Javadoc for my project, The result is fine at the bigining of the generating init: Generating Javadoc Javadoc execution Loading source file...
2
by: MC | last post by:
Has anyone hacked a converter to turn Visual Studio XML documentation into LaTeX?
10
by: kenrocks | last post by:
How can I generate the Javadoc documentation for my Program pls..answer asap...thx:)
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.