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

Document CQL Options file #709

Closed
brynrhodes opened this issue Jan 2, 2022 · 2 comments
Closed

Document CQL Options file #709

brynrhodes opened this issue Jan 2, 2022 · 2 comments

Comments

@brynrhodes
Copy link
Member

Add documentation for the cql options file format the translator uses. Include a JSON Schema file and use it to address the issue in the VSCode plugin: cqframework/vscode-cql#2

@brynrhodes brynrhodes added this to the Maintenance milestone Jan 4, 2022
@brynrhodes
Copy link
Member Author

The CqlTranslatorOptions class represents the options that can be set for the translator:
https://github.com/cqframework/clinical_quality_language/blob/master/Src/java/cql-to-elm/src/main/java/org/cqframework/cql/cql2elm/CqlTranslatorOptions.java

  1. Document the class with JavaDoc tags
  2. Create a JSON Schema file that documents the structure (would be ideal if it could be derived from the CqlTranslatorOptions class and included in the build somehow)
  3. Add a discussion about the CqlTranslatorOptions class and the use of cql-options files in directories with the translator to the Translator documentation here: https://github.com/cqframework/clinical_quality_language/blob/master/Src/java/cql-to-elm/OVERVIEW.md

echicoine-icf pushed a commit to echicoine-icf/clinical_quality_language that referenced this issue Feb 15, 2022
JPercival added a commit that referenced this issue Apr 14, 2022
#709: Added JavaDoc entries to CqlTranslatorOptions
@brynrhodes
Copy link
Member Author

Included in v1.5.7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant