Sandcastle : ASP.NET AJAX Beta 1

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

aram — Thu, 28 Jun 2007 09:42:00 GMT

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 http://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 http://www.codeplex.com/scriptdoc/SourceControl/FileView.aspx?itemId=102696&changeSetId=7167

Steps to document Atlas client side Javascript code comments:

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. http://localhost/scriptdoc/default.aspx?project=MicrosoftAjax). ScriptDoc 1.0 will generate the .org and the .xml output files in the Output directory
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 http://blogs.msdn.com/sandcastle/archive/2006/07/29/Creating-a-Chm-build-using-Sandcastle.aspx
Run steps 5 through 12 of http://blogs.msdn.com/sandcastle/archive/2006/07/29/Creating-a-Chm-build-using-Sandcastle.aspx on reflection.org to generate a CHM
Happy documenting!

Anand..

Documenting Javascript doc comments

aram — Tue, 24 Apr 2007 07:47:00 GMT

Bertrand Leroy, a Software development Engineer, from AJAX team is currently representing Microsoft at the OpenAjax Alliance working group. You can read about the working group’s intentions and planning here: http://www.openajax.org/member/wiki/IDE_Charter.

Today Bertrand bloged about the format of Javascript doc comments. Xml documentation annotations are going to drive JavaScript IntelliSense in Visual Studio Orcas (the next version of Visual Studio). For more than a year now, we've been including xml doc comments to all public APIs in the Microsoft Ajax Library (which are a great place to check out some examples of those comments). You can get more information at his blog http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx.

I have been working with Bertrand to find ways for Sandcastle to generate documentation for Javascript doc comments. He has developed a cool document extraction tool that will generate reflection.org file for Sandcastle. Look for more details in his blog and my future blog.

Anand..

Documentation for ASP.NET AJAX Beta 1 site (http://ajax.asp.net/docs/) using Sandcastle code base

aram — Sat, 21 Oct 2006 09:54:00 GMT

ASP.NET AJAX Beta 1 now available @ http://ajax.asp.net is the culmination of a 1 year cycle since our initial public CTP at PDC in 2005 and is the result the wonderful feedback from all of you in our community. With this release customers can begin building...(read more)