You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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
RegisterAppInterface(Response).displayCapabilities
documentationExpected Behavior
Should state
@added in SmartDeviceLink 2.0
and@deprecated in SmartDeviceLink 6.0
.Observed Behavior
Does not state the above.
OS & Version Information
Test Case, Sample Code, and / or Example App
n/a
The text was updated successfully, but these errors were encountered: