Using doxygen to create documentation for existing C # code with XML comments

Question

I read everywhere that doxygen is a way of developing documentation for C # code. I have one interface that I want to document first (baby steps), and it already has XML comments (///).

Due to the large amount of messages and information (including doxygen.org) that say these comments are already supported, I am surprised that when I run doxywizard, I get errors like "warning: Compound Company :: Product :: MyInterface not documented. "

This makes me believe that I somehow misunderstood the XML documentation (I hope not, according to MSDN I'm talking about the right thing), or I did the wrong doxywizard.

First, I started doxywizard through the Wizard tab and indicated that I want to support C # / Java. When I run it, my HTML page is empty, presumably due to the previously mentioned warnings. Then I tried to specify one file on the Expert tab and run again - the same behavior.

Can someone tell me which switch or parameter I am missing to get doxygen to generate HTML?

Here is an example of how a document / method looks documented in my interface:

/// <summary> /// Retrieve the version of the device /// </summary> String Version { get; } /// <summary> /// Does something cool or really cool /// </summary> /// <param name="thing">0 = something cool, 1 = something really cool</param> void DoSomething( Int32 thing); 

I have a comment on the interface, for example:

 /// <summary> /// MyInterface /// </summary> public interface MyInterface {...} 

Answer 1

I think I get it. The doxygen manual states that EXTRACT_ALL = 0 is the default setting, in which case "will only generate documentation for registered elements, files, classes, and namespaces." Now I thought that I was documenting them correctly, but apparently not. I just turned on EXTRACT_ALL and the warnings went away and I got documentation for my interface! I read the “special documentation blocks” thinking that I was missing something (thanks to Eric Farr comment), but he didn’t mention doing something special for C # code, so I assume that the default value for EXTRACT_ALL should still be working.