[TIMOB-7871] iOS: Finalize module API specification
| GitHub Issue | n/a |
|---|---|
| Type | Bug |
| Priority | High |
| Status | Closed |
| Resolution | Fixed |
| Resolution Date | 2012-03-10T00:50:00.000+0000 |
| Affected Version/s | Release 1.8.0.1 |
| Fix Version/s | Sprint 2012-05, Release 2.0.0 |
| Components | iOS |
| Labels | n/a |
| Reporter | Stephen Tramer |
| Assignee | Max Stepanov |
| Created | 2012-03-02T17:07:10.000+0000 |
| Updated | 2012-03-19T11:03:29.000+0000 |
Description
Based on the initial module API docs, we need to pare down the set of public functions and create a reasonable specification. This will include evaluating the included APIs, excluded but relevant APIs, and determining APIs which should be immediately deprecated for replacement.
Pull merged
Tested with 2.0.0.v20120319003254 1. install the 'appledoc' tool and run the command 'appledoc -o build/apidoc iphone/AppledocSettings.plist' then load up the index.html and make sure it generated correctly appledoc: https://github.com/tomaz/appledoc