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

Build and deploy liboscal-java Javadoc #130

Closed
3 tasks done
kylelaker opened this issue Apr 4, 2023 · 3 comments
Closed
3 tasks done

Build and deploy liboscal-java Javadoc #130

kylelaker opened this issue Apr 4, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@kylelaker
Copy link
Contributor

kylelaker commented Apr 4, 2023

User Story:

As a liboscal-java API consumer, I want to have Javadoc available to understand the API of both custom classes in this library as well as the code automatically generated from the metaschema assemblies.

It looks like this is already done in metaschema-java for its API; hopefully a similar pattern could be used for this library?

Goals:

  • Javadoc is generated as part of the build process
  • Documentation is available in a web browser (possibly at pages.nist.gov like for metaschema-java?)

Dependencies:

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@kylelaker kylelaker added the enhancement New feature or request label Apr 4, 2023
@aj-stein-nist
Copy link
Collaborator

Thanks, this is a good catch. I will look into this.

@aj-stein-nist
Copy link
Collaborator

@aj-stein-nist needs to coordinate with @david-waltermire-nist to test the configuration and work through issues before turning it back on.

@aj-stein-nist
Copy link
Collaborator

This was released as part of 2.0.0. Please review the following API reference pages.

https://pages.nist.gov/liboscal-java/xref/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants