XML Code Documentation

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.

This section explains how to generate help files from the EwE code documentation.

• Download and install Sandcastle ?here
• Sandcastle has no GUI front-end. For this, download and install Sandcastle Help File Builder ?here

Once Sandcastle and Sandcastle help file builder are installed, you can generate the EwE6 API help file:

• 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
• To Build documentation, Click on Documentation > Build Project
• To View documentation, Click on Documentation > View Help File > View Help File

The API code documentation can be accessed online ?here.