Skip to content
This repository has been archived by the owner on Mar 17, 2021. It is now read-only.

Improve JavaDoc on runtime #332

Open
6 tasks
blaumeiser-at-bosch opened this issue Oct 17, 2019 · 0 comments
Open
6 tasks

Improve JavaDoc on runtime #332

blaumeiser-at-bosch opened this issue Oct 17, 2019 · 0 comments
Labels
infrastructure Infrastructure stuff like build and test issues

Comments

@blaumeiser-at-bosch
Copy link
Contributor

Summary of the Improvement

Improve the javadoc situation of explicit apis explicitely in runtime component

Acceptance Criteria

  • Javadoc for every 'official' api is documented

Definition of Done

  • Acceptance criteria fulfilled
  • The ticket describes what has been done and describes how the results can be verified (e.g. new Jenkins step is inserted, the report can be viewed at X)
  • All known limitations are listed and it is described how they will be addressed (e.g., a ticket for the remaining stuff)
  • Documentation is updated
  • The result has been reviewed: Everything works as described and can be verified reading only the documentation
@blaumeiser-at-bosch blaumeiser-at-bosch added the infrastructure Infrastructure stuff like build and test issues label Oct 17, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
infrastructure Infrastructure stuff like build and test issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@blaumeiser-at-bosch