[TIMOB-8349] MobileWeb: Add documentation to the entire mobile web source code
| GitHub Issue | n/a |
|---|---|
| Type | Bug |
| Priority | Low |
| Status | Closed |
| Resolution | Won't Fix |
| Resolution Date | 2017-06-26T18:40:46.000+0000 |
| Affected Version/s | Release 2.0.1 |
| Fix Version/s | n/a |
| Components | MobileWeb |
| Labels | n/a |
| Reporter | Chris Barber |
| Assignee | Chris Barber |
| Created | 2012-03-28T11:01:20.000+0000 |
| Updated | 2018-04-04T23:20:29.000+0000 |
Description
There currently is no documentation of the mobile web platform itself. For this, we will be using the JSDoc format (https://github.com/jsdoc3/jsdoc). The actual parser may be the JSDoc parser or another tool such as Dox (https://github.com/visionmedia/dox).
Seems like the AST parser will be our best option for parsing the JSDoc data out of the code. We might want to use the output from the AST parser to also generate visual graphs of dependencies like this project: https://github.com/pahen/node-madge
As a suggestion, we might want to consider using ScriptDoc or a variant of that format. We could extend ScriptDoc as necessary. https://wiki.appcelerator.org/display/guides2/ScriptDoc+%28SDOC%29+2.0+Specification
Marking ticket as "Won't Fix" as MobileWeb has been deprecated.
Closing as will not fix.