Module ringo/jsdoc

Low level support for parsing JSDoc-style comments from JavaScript files.

Functions

Class ScriptRepository

Instance Methods

ScriptRepository (path)

Create a script repository for the given path

Parameters

String path the base path

Returns

an script repository

ScriptRepository.prototype.exists ()

Check whether this script repository exists.

Returns

boolean true if the repository exists

ScriptRepository.prototype.getPath ()

Get the absolute path of this script repository.

Returns

string the absolute repository path

ScriptRepository.prototype.getScriptResource (path)

Get a script resource contained in this repository.

Parameters

String path the script path

Returns

Resource the script resource

ScriptRepository.prototype.getScriptResources (nested)

Get a list of script resources (files with a .js extension) in this repository.

Parameters

Boolean nested whether to return scripts in nested directories

Returns

Array list of script files as RingoJS Resource objects

parseResource (resource)

Parse a script resource and return an array containing the JSDoc items for the properties it exports.

Parameters

Resource resource a script resource

Returns

Array an array of objects representing the API documentation for of the resource