You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
metaschema-java
?)Dependencies:
Acceptance Criteria
The text was updated successfully, but these errors were encountered: