How to document C# projects/assemblies with XML comments and Doxygen?

I have a C# code base with XML comments and (owing to this site) discovered that Doxygen can easily generate turn code and comments into HTML and PDF documentation So I know how to document classes and other types and their contents.

But how to document projects/assemblies/namespaces? My code base has over 50 of them; their responsibilities must be documented.

I'd prefer to just use XML comments on them as well. but Microsoft's XML commenting manual doesn't give me a clue how to do this, and I can't find any clues in the Doxygen documentation either.

What am I missing? How do you do provide documentation for your C# projects/assemblies?

Update: I now know how to do it with SHFB.

Answers


We too have been in the process of generating the documentation for our assemblies. We have about 20- 25 dll's. We have used Sandcastle [SHFB] and its been a piece of cake. We have used the following procedure.

  1. Check the XML Documentation file in the Project properties [ClassLibrary] and then provide a custom path if required, else the XML will be generated in the bin\debug or bin\release folder.
  2. Then we will fire up the GUI from SandCastle
  3. Then we will place all the pre-requisite dll files in a folder and then we will point to the dlls and the xml files in the UI and then we will build the application. This will generate CHM as well as web pages that you can use to publish in the web as a web help.

Googling a bit will surely give you the screenshot based sample too..

In case you require to use only doxygen, please refer here


Need Your Help

Heroku, hoe gem is not in gemlist, gemfile, gemfile.lock. Why is it trying to install it anyways?

ruby-on-rails git heroku

I'm trying to push to Heroku and it insists on trying to install a gem I do not have anywhere in my app. I've have the latest changes committed to my git repo. The gem is hoe. I've tried the vers...

About UNIX Resources Network

Original, collect and organize Developers related documents, information and materials, contains jQuery, Html, CSS, MySQL, .NET, ASP.NET, SQL, objective-c, iPhone, Ruby on Rails, C, SQL Server, Ruby, Arrays, Regex, ASP.NET MVC, WPF, XML, Ajax, DataBase, and so on.