Changes between Version 10 and Version 11 of CodeDocumentation


Ignore:
Timestamp:
2010-04-04 08:53:37 (9 years ago)
Author:
jeroens
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CodeDocumentation

    v10 v11  
    11= XML Code Documentation = 
    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. 
     2Microsoft Visual Studio allows code documentation to be incorporated in supported sources, which can be compiled via third-party tools into API help files. The structure of source code comments must adhere to the [http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language Windows Assistance Markup Language (MAML)] standard. This section explains how to generate EwE6 API help files from the EwE6 source code projects. 
    33 
    4 This section explains how to generate EwE6 API help files from the EwE6 source code projects. 
     4In the past we used [http://en.wikipedia.org/wiki/NDoc NDoc] to create API documentation of our sources. The NDoc project has been abandoned in 2007, but thankfully Microsoft supports a tool called '[http://en.wikipedia.org/wiki/Sandcastle_(software) Sandcastle]'. 
    55 
    66 * Download and install Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here]