[ALOY-199] Documentation: Make Alloy safe for documentation
| GitHub Issue | n/a |
|---|---|
| Type | Story |
| Priority | High |
| Status | Resolved |
| Resolution | Fixed |
| Resolution Date | 2012-08-27T07:51:42.000+0000 |
| Affected Version/s | n/a |
| Fix Version/s | n/a |
| Components | Documentation |
| Labels | n/a |
| Reporter | Arthur Evans |
| Assignee | Unknown |
| Created | 2012-08-22T11:25:34.000+0000 |
| Updated | 2018-03-07T22:26:15.000+0000 |
Description
To build the Alloy docs using JSDuck, we need to comment the classes that should be exposed, and remove any comments that look like doc comments--that is if we do this:
/**
* Do something here.
*/
exports._ = function() ...
/\*\* into a regular comment intro /\* eliminates the rogue method.
Currently, it looks like we should be building docs from Alloy/builtins and Alloy/lib.
Pull request ready: https://github.com/appcelerator/alloy/pull/51
merged arthur's PR and made a few small adjustments