This project is read-only.

VSDoc2JSDoc 1.0

Rating: No reviews yet
Downloads: 118
Change Set: 13944
Released: Jun 4, 2012
Updated: Jun 4, 2012 by JayDataOrg
Dev status: Stable Help Icon

Recommended Download

Application VSDoc2JsDoc
application, 245K, uploaded Jun 4, 2012 - 100 downloads

Other Available Downloads

Source Code VSDoc2JsDoc 1.0 Source
source code, 234K, uploaded Jun 4, 2012 - 18 downloads

Release Notes

Project Description

The goal of this project is to convert VSDoc JavaScript comments of JayData classes to JSDoc comment format. Using this tool you can generate the API reference of your JayData components and keep your JavaScript documentation up-to-date.

Features

  • BBCode support, so we don’t need to deal with HTML escaping, which would be needed because of embedding into XML format.
  • Recognizes JayData class definitions: $C, $data.Class.define, $data.Class.defineEx, baseClass.extend.
  • Signature can be added to function parameters.
  • The output of this tool can be used to generate HTML documentation (using jsdoc-toolkit)

Command line options

  • -i, --index The path of the XML file, which enlists the files to process. Ex.: [file:JayData_index.xml]
  • -p, --projectDir input project folder path (file paths in index file must be relative to this folder)
  • -o, --output target folder path
  • -c, --config desired output config file path of generated for jsdoc-toolkit

Example to run the tool
Vsdoc2jsdoc.exe --projectDir C:\JayData --index  C:\JayData\JayData_Index.xml --config  C:\JayData\apidoc\jsdoc.config --output  C:\JayData\apidoc\js 

Reviews for this release

No reviews yet for this release.