[TIMOB-7860] Tooling: docgen.py Accessors for deprecated properties should also be deprecated
GitHub Issue | n/a |
---|---|
Type | Bug |
Priority | Medium |
Status | Closed |
Resolution | Fixed |
Resolution Date | 2012-03-21T16:00:20.000+0000 |
Affected Version/s | Release 1.8.2 |
Fix Version/s | Release 2.0.0, Sprint 2012-06 |
Components | Tooling |
Labels | qe-doc |
Reporter | Arthur Evans |
Assignee | Arthur Evans |
Created | 2012-03-01T17:42:28.000+0000 |
Updated | 2013-01-21T20:53:42.000+0000 |
Description
This causes some confusion, for example, because the Ti.UI module includes a getOrientation method, which is *not* marked deprecated, which is actual an accessor for a deprecated property.
Testing Notes
-------------
To test the fix, run docgen once before pulling the fix branch. Open dist/apidoc/Titanium.UI-module.html and note that getOrientation and setOrientation do *not* show a "Deprecated" text at the beginning of the summary line, but the related "orientation' property does.
Then pull the fix branch and run docgen again. getOrientation and setOrientation should now show "Deprecated" at the beginning of the summary line, and if you click through to the method description, you should see the full deprecation message--"Deprecated since 1.7.2" or words to that effect.
For extra credit, you can edit UI.yml, find name: orientation and add a "removed" tag to the deprecation warning:
deprecated: { since: "1.7.2", removed: "2.0.0" }
Re-run docgen, and you should see the "removed 2.0.0" text on the method pages as well.
PR 1775 addresses this change, at least for the HTML generator: https://github.com/appcelerator/titanium_mobile/pull/1775 Need to integrate and test with the JSDuck generator separately.
Closing as fixed. Tested and verified with: appcelerator / titanium_mobile latest commit 7966135c19 Titanium Studio, build: 3.0.1.201212181159 Titanium SDK, build: 3.0.2.v20130118180632