Skip to content

Code generator includes quotes from YAML strings in generated Javadoc #568

@david-waltermire

Description

@david-waltermire

Description

When generating Java binding classes from YAML Metaschema modules, the code generator includes the literal quote characters from YAML string values in the generated Javadoc comments.

Example

YAML source (metaschema-testing unit-tests.yaml):

- name: "location"
  description: "A URI reference to the metaschema module location."

Generated Javadoc (Metaschema.java):

/**
 * "A URI reference to the metaschema module location."
 */

Expected Javadoc:

/**
 * A URI reference to the metaschema module location.
 */

Impact

  • Generated Javadoc has extraneous quote characters
  • Affects all generated binding classes from YAML modules

Suggested Fix

The code generator should strip leading/trailing quotes from description strings when generating Javadoc comments.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions