Titanium JIRA Archive
Titanium SDK/CLI (TIMOB)

[TIMOB-27688] TiAPI: Clean up apidocs to use common types

GitHub Issuen/a
TypeImprovement
PriorityNone
StatusClosed
ResolutionFixed
Resolution Date2019-12-17T16:34:33.000+0000
Affected Version/sn/a
Fix Version/sRelease 9.0.0
ComponentsiOS
Labelsn/a
ReporterChristopher Williams
AssigneeChristopher Williams
Created2019-12-16T19:25:25.000+0000
Updated2020-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.

Comments

  1. Christopher Williams 2019-12-16

    https://github.com/appcelerator/titanium_mobile/pull/11391
  2. Christopher Williams 2019-12-17

    merged to master - no real QE FR to do since this is docs only.
  3. Lokesh Choudhary 2020-01-03

    Closing.

JSON Source