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 spec generator does not add parameter descriptors for the enum data type #1751

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

Comments

@NicoleYarroch
Copy link
Contributor

Bug Report

RPC spec generator does not add parameter descriptors for the enum data type which is an issue when the enum has a default value.

For example, the SoftButton systemAction parameter is an enum with a defvalue set to DEFAULT_ACTION

<struct name="SoftButton" since="2.0">
    ...
    <param name="systemAction" type="SystemAction" defvalue="DEFAULT_ACTION" mandatory="false">
        <description>Parameter indicating whether selecting a SoftButton shall call a specific system action.  This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</description>
    </param>
</struct>
Reproduction Steps
  1. Run the generator script in the "generator" folder of the library.
Expected Behavior

It should generate the following:

/**
 * Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to
 * allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can
 * persist when a SoftButton is pressed.
 * {"default_value": DEFAULT_ACTION}
 */
@property (nullable, strong, nonatomic) SDLSystemAction systemAction;
Observed Behavior

It does not add the default value to the description:

/**
 * Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to
 * allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can
 * persist when a SoftButton is pressed.
 */
@property (nullable, strong, nonatomic) SDLSystemAction systemAction;
OS & Version Information
  • iOS Version: n/a
  • SDL iOS Version: 6.7
  • Testing Against: n/a
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
3 participants