ScriptDoc 1.0 for extractiong Javascript code comments is now available at Codeplex

  • Article

In April I blogged about Bertrand Leroy's, cool document extraction tool (ScriprDoc 1.0) that will generate reflection.org file for Javascript. Today Bertrand released ScriptDoc 1.0 at CodePlex. Please see more details at https://weblogs.asp.net/bleroy/archive/2007/06/27/scriptdoc-1-0-available.aspx.

As a part of this release we also made the reflection schema (reflection.xsd) of Sandcastle available at https://www.codeplex.com/scriptdoc/SourceControl/FileView.aspx?itemId=102696&changeSetId=7167

Steps to document Atlas client side Javascript code comments:

  1. Run ScriptDoc 1.0 on the project you want to generate documentation. To do this set up an ASP.NET (2.0 or above) that points to the root directory. You must have Microsoft Ajax installed on the machine. You will need write access to the Output directory. Browse to the application, specifying the project you want to generate documentation for in the “project” querystring parameter (e.g. https://localhost/scriptdoc/default.aspx?project=MicrosoftAjax). ScriptDoc 1.0 will generate the .org and the .xml output files in the Output directory
  2. The output from ScriptDoc 1.0 will be the reflection.org file generated by MrefBuilder component of Sandcastle. This is the output generated in step 4 Sandcastle build process outlined at https://blogs.msdn.com/sandcastle/archive/2006/07/29/Creating-a-Chm-build-using-Sandcastle.aspx
  3. Run steps 5 through 12 of https://blogs.msdn.com/sandcastle/archive/2006/07/29/Creating-a-Chm-build-using-Sandcastle.aspx on reflection.org to generate a CHM
  4. Happy documenting!

 ScriptDoc 1.0

 Anand..