Changes between Version 4 and Version 5 of CodeDocumentation

Timestamp:

2010-03-11 18:23:01 (14 years ago)

Author:

jeroens

Comment:

--

CodeDocumentation

@@ -2 +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.
 
- * Download Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here]
- * Sandcastle has no GUI front-end. For this, download Sandcaste Help File Builder [http://www.codeplex.com/SHFB here]
+This section explains how to generate help files from the EwE code documentation.
 
-Now install Sandcastle and the Sandcastle Help File Builder.
+ * Download and install Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here]
+ * Sandcastle has no GUI front-end. For this, download and install Sandcastle Help File Builder [http://www.codeplex.com/SHFB here]
 
- * Open Sandcastle Help File Builder and load a project
+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 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.
-
 The API code documentation can be accessed online [http://webservice.ecopath.org/Help/index.aspx here].