I export the class diagrams into a 'png' file. The html generated from NDoc references that file. When compiling the html to chm, the images are inlcuded into the chm file. Not too elegant I know, however...
The details:
1. Save the diagrams as images into a subfolder 'images' of your NDoc's html files. (I think Ndoc sometimes deletes all files in a directory, no subdirectories though). Filenames could follow a scheme like NS1.NS2.NS3.png
2. In the source code, I add per namespace a class with name NamespaceDoc, which is used from NDoc to document a namespace;-)
3. The compiler exports xml, even when it doesn't know the tags. So I add an 'img' tag in the documentation of the class.
namespace NS1.NS2.NS3{
/// <summary>Description of this namespace
/// <img src="images/NS1.NS2.NS3.png" /></summary>
public class NamespaceDoc{
}
}
4. Recompile the solution
5.1 In the NDoc Project (Documentation Type: MSDN), set the OutputTarget property to 'HtmlHelpAndWeb'
5.2 set the 'UseNameSpaceDocSummaries' to true.
6. Build the NDoc project and you should be able to see the images in both the html pages and the chm file.
If you know of any more elegant way, let me know.
Matthias
Show Posts
