C++\CLI: Supress XML Document Generator for unmanaged header files?

[Apoxy]

Is there a way to suppress the XML Document Generator in such a way
that it ignores header files? The ACE headers used in my project
unfortunately contain a lot of comments starting with "///" that
aren't intended for use as XML documentation comments. The doc
generator tries to parse them anyway and since most of them constitute
malformed XML doc comments, the compiler generates zillions of
warnings, not to mention an overly large and difficult to read XML
help file.

Is there any way I can stop this from happening?

Thanks!

 

[Ben Voigt [C++ MVP]]

Is there a way to suppress the XML Document Generator in such a way
that it ignores header files? The ACE headers used in my project
unfortunately contain a lot of comments starting with "///" that
aren't intended for use as XML documentation comments. The doc
generator tries to parse them anyway and since most of them constitute
malformed XML doc comments, the compiler generates zillions of
warnings, not to mention an overly large and difficult to read XML
help file.

Is there any way I can stop this from happening?

Try turning off xml documentation entirely in the compiler, and use doxygen
instead. I helped add support for most C++/CLI-specific keywords so it
ought to work fairly well for you.

 

[Apoxy]

Try turning off xml documentation entirely in the compiler, and use doxygen

instead. I helped add support for most C++/CLI-specific keywords so it
ought to work fairly well for you.

Thanks, but I'm fairly happy with the way the XML docs are working
otherwise. I'm most interested in preserving the intellisense
functionality, so I don't think doxygen is the way to go for this one.

 

[Ben Voigt [C++ MVP]]

Thanks, but I'm fairly happy with the way the XML docs are working
otherwise. I'm most interested in preserving the intellisense
functionality, so I don't think doxygen is the way to go for this one.

Does intellisense depend on the compiler for XML comments support? I
thought intellisense had its own parser.

Doxygen does support the MS XML comment format as well as javadoc-style
tags.

 

[Carl Daniel [VC++ MVP]]

Does intellisense depend on the compiler for XML comments support? I
thought intellisense had its own parser.

It doesn't depend on it, but it is aware of it - it'll pick up
function/parameter documentation from the Xml comments and include it in the
tooltips that it generates.

-cd

 

[Ben Voigt [C++ MVP]]

It doesn't depend on it, but it is aware of it - it'll pick up
function/parameter documentation from the Xml comments and include it in
the tooltips that it generates.

But does intellisense's parser grab the xml comments from the source file,
or does it grab the documentation output from the compiler?

 

[Hendrik Schober]

[...]

Does intellisense depend on the compiler for XML comments support? I
thought intellisense had its own parser.

It doesn't depend on it, but it is aware of it - it'll pick up
function/parameter documentation from the Xml comments and include it in the
tooltips that it generates.

It does the same for our doxygen comments.

-cd

Schobi

--
(e-mail address removed) is never read
I'm HSchober at gmx dot de
"If there were some arcane way to remove the heads of every
newsgroup troll on the planet, I think it would elevate
humans to a whole new level of intelligence."
Rocky Frisco

 

[Carl Daniel [VC++ MVP]]

But does intellisense's parser grab the xml comments from the source file,
or does it grab the documentation output from the compiler?

I believe that it parses the comments, not the compiler output.

-cd

 

[Carl Daniel [VC++ MVP]]

[...]

Does intellisense depend on the compiler for XML comments support? I
thought intellisense had its own parser.

It doesn't depend on it, but it is aware of it - it'll pick up
function/parameter documentation from the Xml comments and include it in
the
tooltips that it generates.

It does the same for our doxygen comments.

Cool. I didn't know it did that

-cd

 

[Ben Voigt [C++ MVP]]

[...]
Does intellisense depend on the compiler for XML comments support? I
thought intellisense had its own parser.

It doesn't depend on it, but it is aware of it - it'll pick up
function/parameter documentation from the Xml comments and include it in
the
tooltips that it generates.

It does the same for our doxygen comments.

Cool. I didn't know it did that

Intellisense has supported code comments long before the XML style was
created.