issue-1384: Fluent API - Add JavaDoc to core workflow builders [TIER 1]#1385
Draft
domhanak wants to merge 1 commit into
Draft
issue-1384: Fluent API - Add JavaDoc to core workflow builders [TIER 1]#1385domhanak wants to merge 1 commit into
domhanak wants to merge 1 commit into
Conversation
Signed-off-by: Dominik Hanak <dhanak@redhat.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Many thanks for submitting your Pull Request ❤️!
What this PR does / why we need it:
This PR is initial draft of the JavaDoc implementation proposed in #1384
Special notes for reviewers:
This is a result of analysis using IBM Bob, I am creating this draft PR to gather feedback and also have better view on the result ( I prefer reviewing here in GH )
Additional information (if needed):
Bob analyzed we have 4 TIERS ( we should prioritize - 1 highest, 4 lowest )
Each tier is split into smaller unit and this is a result of Bob solving first part of TIER 1
TIER 1 JavaDoc improvements - Unit 1.1: Fluent API Core Workflow Builders<- This PRPending, will continue if we deem the result good:
TIER 1 JavaDoc improvements - Unit 1.2: Fluent API Call & Communication TasksTIER 1 JavaDoc improvements - Unit 1.3: Fluent API Event HandlingTIER 1 JavaDoc improvements - Unit 1.4: Fluent API Error Handling & Control FlowTIER 1 JavaDoc improvements - Unit 1.5: Core Runtime Application & DefinitionTIER 1 JavaDoc improvements - Unit 1.6: Core Runtime Instance & ExecutionTIER 1 JavaDoc improvements - Unit 1.7: AnnotationsGuidelines applied when generating the docs: