This project has moved. For the latest updates, please go here.
Project Description
This application generates documentation for Atlas client script libraries.

This works as an ASP.NET 2.0 web application.

Documentation is generated from the source code of the classes defined in files and namespaces defined in a project file. The project to use is specified using the project query string parameter. For example, if you have built the project file myProject.xml in the Projects directory, browsing to default.aspx?project=myProject will generate the Output/myProject.xml and Output/ documentation and reflection files.

The tool can work in the absence of specific documentation information in the source code but the usefulness of such documentation will be small.
To include real documentation, you can use the /// comments that are familiar to C# developers with one essential difference: the comments have to be inside of the class or method definition.

Here's a simple example of class documentation:

Sys.Data.DataView = function() {
   /// <summary>
   ///   DataView filters its input data through a collection of filters.
   ///   It can also paginate and sort data.
   /// </summary>

   // [... actual definition of the class ...]

Here's an example of method documentation:

this.getItem = function(index) {
   /// <summary>
   ///   Gets an item in the filtered data by index.
   /// </summary>
   /// <param name="index">The index in the filtered data of the row to return.</param>
   /// <returns>Null if the row was not found.</returns>

   return _filteredTable ? _filteredTable[index] : null;

And finally, here's an example of a property's documentation (notice how the
documentation is on the getter only, not on the setter):

this.get_data = function() {
   /// <value>
   ///   The data that the view will filter.
   /// </value>

   return _data;
this.set_data = function(data) {
   _data = data;

More information about the format of doc comments for JavaScript can be found here.

To be able to write the output XML file, the application must have write access to the output directory. For this reason and also because I didn't especially look for possible injection attacks, this application should never be exposed publicly on the Internet. I recommend making it only accessible locally.

One more thing: for all this to work, the application must be installed in an ASP.NET Ajax application. This means the right web.config, that ASP.NET Ajax is installed on the machine and of course the script files that you wish to document are where the project file points.

This should not be confused with ScriptDoc, or JSDoc, which are annotation formats for JavaScript. ScriptDoc is a name I originally picked before I learned about those and that describes the extraction tool. I since renamed the project to "AjaxDoc" which seems to be unused currently. The annotation format that the tool uses, and which is described elsewhere, should be referred to as "JavaScript doc comments".

Last edited Aug 22, 2007 at 9:57 PM by BertrandLeRoy, version 7