| 1 | In the past we used NDoc to create API documentation of our sources. The NDoc project has been abandoned in 2007, but thankfully Microsoft has finally released a tool called 'Sandcastle' to generate help text from Visual Studio XML code comments. |
| 2 | |
| 3 | * Download Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here] |
| 4 | * Sandcastle has no GUI front-end. For this, download Sandcaste Help File Builder [http://www.codeplex.com/SHFB here] |
| 5 | |
| 6 | Now install Sandcastle and the Sandcastle Help File Builder. |
| 7 | |
| 8 | * Open Sandcastle Help File Builder and load a project |
| 9 | * To Build documentation, Click on Documentation > Build Project |
| 10 | * To View documentation, Click on Documentation > View Help File > View Help File |
| 11 | |
| 12 | The EwE6 project contains a Sandcastle project in Ecopath6\Sources\Documentation\EwECore.shfbproj, which can be ran to create a Windows CFM document describing the EwE6 core projects. |