Version 3 (modified by sunk, 9 years ago) (diff)

--

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.

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

Now install Sandcastle and the Sandcastle Help File Builder.

  • Open Sandcastle Help File Builder and load a project
  • To Build documentation, Click on Documentation > Build Project
  • To View documentation, Click on Documentation > View Help File > View Help File

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.

Online Documentation