Last updated 10/16/2005 by
Ingo Muschenetz
CONTENTS
- Disclaimer
- Overview
- Binary Installation
- Source Installation
- Version History
1. DISCLAIMER
THE SOFTWARE IS SUPPLIED "AS IS". THIS SITE DISCLAIMS ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION,
THE WARRANTIES OF MERCHANTABILITY AND OF FITNESS FOR ANY PURPOSE. THE USER MUST ASSUME THE ENTIRE RISK OF USING THE SOFTWARE.
2. OVERVIEW
NDoc is a fantastic documentation tool and has served me well in multiple projects. However, the documentation style has become
a bit dated, and Microsoft has recently updated the documentation style to coincide with the release of .NET Framework version 2.0. This is a plug-in documenter designed to update the style to more closely match what the MSDN site provide.
Before
 | After
 |
If you wish to see a live example, click on the following link: http://www.muschenetz.com/projects/SharpHIP
3. FEATURES
This documenter builds on the MSDN2 (beta) documenter available in NDoc, but updated with a few new features, including a
simplified stylesheet, new gradient graphics, and expandable and collapsible headers. A few notable bugs remain:
- The current template is designed for generating HTML documents. The generated CHM document still has a few issues
- Clicking on the intra-document links (i.e. members, references, etc.) will cause both the top and bottom sections to scroll
4. BINARY INSTALLATION
- Download the latest version of the binary.
- Copy the NDoc.Documenter.MSDNWinFX.dll into the binaries folder of NDoc. This is most likely in the same place as the actual NDoc.exe.
- Run NDoc like normal. You should see an extra documenter in the drop-down list named MSDN WinFX (beta)
5. SOURCE INSTALLATION
- Download the latest version of the source.
- Unpack the .zip file and save it to a convenient location
- When opening up the solution (it is a VS2003 solution), you may need to fix the reference to "core". This is the reference
to the ndoc.core.dll file (located in the NDoc binaries folder).
- Modify and build as normal. A few hints:
- Normally, the documenter will extract the embedded resources from the .dll when in Release mode. If in Debug mode, it
will attempt to load them from disk. This can be useful while debugging stylesheets. You may, however, have to play with
the placement of the folders
- To test, copy the .dll into the same location as the NDoc binary. If replacing an older version, you will most liely need to
close down NDoc to prevent any file locking
If you should have any questions, please feel free to contact me at ingo at muschenetz.com.
5. VERSION HISTORY
Version 0.5: 10/16/2005
