Changes between Version 11 and Version 12 of CodeDocumentation

Timestamp:

2010-04-04 08:57:18 (15 years ago)

Author:

jeroens

Comment:

--

CodeDocumentation

@@ -1 +1 @@
 = XML Code Documentation =
-Microsoft 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.
+Microsoft Visual Studio allows developers to write source code documentation, which can be compiled via third-party tools into API help files. This section explains how to generate EwE6 API help files from the EwE6 source code projects.
 
-In 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]'.
+In 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]'.
 
  * Download and install Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here]
@@ -16 +16 @@
 
 = Links = 
-Lots of information is available on XML tags supported in Visual Studio. A few comprehensive links are:
+Whether you write your own code, extend or hijack the Ecopath sources for illegitimate purposes, you may want to add code documentation of your own. Lots of information is available on XML tags supported in Visual Studio. A few comprehensive links are:
+ * [http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language Windows Assistance Markup Language (MAML)] - XML standard that defines the source code comments structure.
  * [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx XML comments overview] - Microsoft XML comments primer in C# syntax, with detailed info on sub-tags such as <list type="...">. A good read.
  * [http://www.codeproject.com/KB/XML/csharpcodedocumentation.aspx XML comments guidelines] - XML comments usage guidelines