[TIMOB-24902] Windows: Update ti_win_yaml to allow specifying deprecated and added in versions
| GitHub Issue | n/a |
|---|
| Type | Improvement |
|---|
| Priority | Medium |
|---|
| Status | Closed |
|---|
| Resolution | Won't Do |
|---|
| Resolution Date | 2021-02-11T12:16:21.000+0000 |
|---|
| Affected Version/s | n/a |
|---|
| Fix Version/s | n/a |
|---|
| Components | Tooling, Windows |
|---|
| Labels | documentation |
|---|
| Reporter | Ewan Harris |
|---|
| Assignee | Unknown |
|---|
| Created | 2017-06-28T11:25:35.000+0000 |
|---|
| Updated | 2021-02-11T12:16:21.000+0000 |
|---|
Description
Description
Currently (to my knowledge) ti_win_yaml doesn't allow for us to specify when something was deprecated or implemented. So it appears that everything is being marked as 4.1.0 on docs.appcelerator.
For deprecated items I guess the simplest/easiest way would be to add a new C++ macro like TITANIUM_FUNCTION_DEPRECATED(foo, 6.1.0), this would fit in with the existing pattern.
Specifying when something was implemented might be a little more difficult, for the namespace (Ti.FileSystem) could we use an \@since 6.1.0, but for individual properties and functions I'm unsure
Comments
JSON Source
[~kota] [~gmathews] I believe both of you have worked on ti_win_yaml at some point in time? Any input/thoughts you have as to how we could achieve this?