[TIMOB-27688] TiAPI: Clean up apidocs to use common types
GitHub Issue | n/a |
---|---|
Type | Improvement |
Priority | None |
Status | Closed |
Resolution | Fixed |
Resolution Date | 2019-12-17T16:34:33.000+0000 |
Affected Version/s | n/a |
Fix Version/s | Release 9.0.0 |
Components | iOS |
Labels | n/a |
Reporter | Christopher Williams |
Assignee | Christopher Williams |
Created | 2019-12-16T19:25:25.000+0000 |
Updated | 2020-01-03T15:52:58.000+0000 |
Description
Our APIdocs frequently re-use similar arguments to methods but are not consistent in referring to those object shapes as defined types. Additionally, there may be duplicated types, types that haven't been defined but should be, or types that are defined but methods/properties don't refer to them and instead use generic Object/Dictionary type.
This is relevant to have properly define docs, but also in that we have started to ship typescript definitions generated from he docs and can rely on these more formal definitions in editors/IDE for more reliable content assist.
https://github.com/appcelerator/titanium_mobile/pull/11391
merged to master - no real QE FR to do since this is docs only.
Closing.