Changes between Version 4 and Version 5 of CodeDocumentation


Ignore:
Timestamp:
2010-03-11 18:23:01 (9 years ago)
Author:
jeroens
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CodeDocumentation

    v4 v5  
    22In 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. 
    33 
    4  * Download Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here] 
    5  * Sandcastle has no GUI front-end. For this, download Sandcaste Help File Builder [http://www.codeplex.com/SHFB here] 
     4This section explains how to generate help files from the EwE code documentation. 
    65 
    7 Now install Sandcastle and the Sandcastle Help File Builder. 
     6 * Download and install Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here] 
     7 * Sandcastle has no GUI front-end. For this, download and install Sandcastle Help File Builder [http://www.codeplex.com/SHFB here] 
    88 
    9  * Open Sandcastle Help File Builder and load a project 
     9Once Sandcastle and Sandcastle help file builder are installed, you can generate the EwE6 API help file: 
     10 
     11 * Open Sandcastle Help File Builder and load the EwE6 help file project. This project is included with the EwE6 sources at Ecopath6\Sources\Documentation\EwECore.shfbproj 
    1012 * To Build documentation, Click on Documentation > Build Project 
    1113 * To View documentation, Click on Documentation > View Help File > View Help File 
    1214 
    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  
    1515The API code documentation can be accessed online [http://webservice.ecopath.org/Help/index.aspx here].