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

Plugin doc integration #148

Open
cmnbroad opened this issue Jan 14, 2019 · 0 comments
Open

Plugin doc integration #148

cmnbroad opened this issue Jan 14, 2019 · 0 comments

Comments

@cmnbroad
Copy link
Collaborator

The doc gen code (DefaultDocWorkUnitHandler.addDefaultPlugins) populates the freemarker map with a nested map named using the value from the returned by the plugin's getDisplayName method, and adds name and file entries for each default instance retuned from the plugin's getDefautlnstances method. This needs to be generalized:

  • the method getDisplayName has a misleading name, since its actually used as a property name, which in turn needs to be a valid freemarker variable name (i.e., read-filter isn't valid)
  • plugins arg values are not necessarily@DocumentedFeature annotated, so they won't necessarily have a corresponding help file name
  • the current system works for GATK read filters, but the GATK annotation plugin has separate default annotations and annotation groups. this may need to be extended to accommodate that case.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant