Titanium JIRA Archive
Titanium SDK/CLI (TIMOB)

[TIMOB-10241] APIDoc: docgen.py should mark creator method as deprecated when the associated object is deprecated

GitHub Issuen/a
TypeBug
PriorityMedium
StatusClosed
ResolutionFixed
Resolution Date2012-08-22T13:20:41.000+0000
Affected Version/sRelease 1.7.6
Fix Version/sSprint 2012-17 Core, Release 3.0.0
ComponentsTooling
Labelsn/a
ReporterArthur Evans
AssigneeBill Dawson
Created2011-12-11T11:37:59.000+0000
Updated2012-12-04T22:56:44.000+0000

Description

Added a deprecated version of Ti.UI.3DMatrix, but Ti.UI.create3DMatrix shows up as non-deprecated. We could add it back in manually and deprecate it, but it seems like it should be deprecated automatically. There might be some issues here with producing the correct documentation, however. If the deprecation annotation included an alternate field (or something like that) identifying the Ti type replacing the object, we could generate the appropriate summary text automatically. Have to think on that, but I'm noting the issue now before I forget it.

Comments

  1. Arthur Evans 2012-07-30

    Would like to propose adding information a text field to the deprecation tag.
  2. Bill Dawson 2012-08-21

    Testing Notes

    * Open apidoc/Titanium/UI/Button.yml in an editor. * Add ... 
       deprecated: {since: "2.2.0"}
    ... near the top (like under summary would be fine.) * Run python apidoc/docgen.py * When it's finished open dist/apidoc/index.html in a web browser. * Navigate to Titanium.UI and to the list of methods therein. * Find the createButton method in the list and click on it. * At the createButton's documentation page you should see that the method has been deprecated since 2.2.0.
  3. Bill Dawson 2012-08-21

    PR ready https://github.com/appcelerator/titanium_mobile/pull/2800
  4. Natalie Huynh 2012-12-04

    Tested with 3.0.0.v20121130200208

JSON Source