Changes between Version 2 and Version 3 of CodeDocumentation
- Timestamp:
- 2010-01-15 12:35:57 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CodeDocumentation
v2 v3 1 1 = XML Code Documentation = 2 3 2 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. 4 3 5 4 * Download Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here] 6 * Sandcastle has no GUI front-end. For this, download Sandcaste Help File Builder [http://www.codeplex.com/SHFB here] 5 * Sandcastle has no GUI front-end. For this, download Sandcaste Help File Builder [http://www.codeplex.com/SHFB here] 7 6 8 7 Now install Sandcastle and the Sandcastle Help File Builder. … … 13 12 14 13 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. 14 15 [http://webservice.ecopath.org/Help/index.aspx Online Documentation]