Doxygen Mainpage-like tag for XML comments

  • Thread starter Thread starter Bob Johnson
  • Start date Start date
B

Bob Johnson

I have looked through the docs for the XML documentation tags in the
C# Programmer's Reference, and I haven't come across a "MAINPAGE" tag
like you find in Doxygen. This tag is nice for when you want to give
the reader a broad overview of your software architecture and then
give them links to the main software blocks. Does anyone have any
experience creating main pages using the C# XML documenter?

--Bob
 
If you use NDoc you can link your own HTML files into the finished CHM at
compile time.
 
Can I create links back to the NDoc documentation inside my external
HTML files? The scenario here would be to write a class name in the
external HTML and have NDoc create a link to that class'
documentation.
 
I'm not sure about that, I've never tried it. But by just looking at the
output files, it looks like NDoc generates pretty standard links that match
class names in the assemblies its documenting. You could probably figure out
what the link to a given class/enum/field/etc is going to look like and use
that.

Mind you NDoc may have some functionality that might help you with this.
It's extremely customizable, especially if you use the command line
interface instead of the GUI.
 
Back
Top