Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RPC Generator should create correct history documentation #1761

Closed
joeljfischer opened this issue Aug 31, 2020 · 0 comments
Closed

RPC Generator should create correct history documentation #1761

joeljfischer opened this issue Aug 31, 2020 · 0 comments
Assignees
Labels
bug A defect in the library rpc-spec-generator Relating to the RPC spec generator

Comments

@joeljfischer
Copy link
Contributor

Bug Report

Currently the generator for the RPC Spec will add the below documentation when the since attribute is available.
@since SmartDeviceLink X.X

When something is deprecated in the RPC spec this is still the case. This can be confusing because it could be interpreted and something being added and deprecated within the same version. We would like to change this behavior in the generator.
If the deprecated attribute is true and the since attribute is available the documentation should instead include:
@deprecated in SmartDeviceLink X.X

When a parameter is added, the documentation should state:
@added in SmartDeviceLink X.X

RPC Spec Mobile API Versioning Proposal: https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals/0089-mobile-api-versioning.md

Reproduction Steps
  1. Run the generator
  2. Look at RegisterAppInterface(Response).displayCapabilities documentation
Expected Behavior

Should state @added in SmartDeviceLink 2.0 and @deprecated in SmartDeviceLink 6.0.

Observed Behavior

Does not state the above.

OS & Version Information
  • iOS Version: n/a
  • SDL iOS Version: n/a
  • Testing Against: n/a
Test Case, Sample Code, and / or Example App

n/a

@joeljfischer joeljfischer added bug A defect in the library rpc-spec-generator Relating to the RPC spec generator labels Aug 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A defect in the library rpc-spec-generator Relating to the RPC spec generator
Projects
None yet
Development

No branches or pull requests

2 participants