fix: fix javadoc warning in ShoppingCart test example#556
Merged
Conversation
Motivation:
Javadoc warning: `{@link Summary}` cannot be resolved because `Summary`
is an inner class of `ShoppingCart` and needs the enclosing class prefix.
Modification:
- Replace `{@link Summary}` with `{@link ShoppingCart.Summary}`
- Replace `{@link Confirmation}` with `{@link ShoppingCart.Confirmation}`
Result:
Javadoc warning is eliminated.
Tests:
Not run - docs only
References:
None
Motivation: CI javafmtCheck fails on the javadoc warnings PR due to unformatted Java files. Modification: Run sbt javafmt to auto-format all Java source files. Result: CI javafmtCheck should now pass.
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
2 participants
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.
Motivation
Javadoc warning in
examples/src/test/java/jdocs/eventsourced/ShoppingCart.java:{@link Summary}and{@link Confirmation}cannot be resolved because they are inner classes ofShoppingCartand need the enclosing class prefixModification
{@link Summary}with{@link ShoppingCart.Summary}{@link Confirmation}with{@link ShoppingCart.Confirmation}Result
Javadoc warning is eliminated.
Tests
Not run - docs only
References
None