feat(java): Indicate if method param is required #762
Merged
Conversation
This file contains 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
bmaizels
suggested changes
Sep 3, 2019
...lc/java/src/main/java/software/amazon/jsii/tests/calculator/UsesInterfaceWithProperties.java
Outdated
Show resolved
Hide resolved
dagnir
force-pushed
the
dongie/fix-365
branch
from
f2ad764
to
a15666f
Compare
|
Looks like you removed 'the value to be set' from builder setters. I think we only wanted to remove them from method parameters and constructor args? |
rix0rrr
reviewed
Sep 4, 2019
...cted.jsii-calc/java/src/main/java/software/amazon/jsii/tests/calculator/UnionProperties.java
Outdated
Show resolved
Hide resolved
dagnir
force-pushed
the
dongie/fix-365
branch
from
a15666f
to
019ee3c
Compare
|
Please fix PR title and add rationale in description |
rix0rrr
reviewed
Sep 5, 2019
dagnir
force-pushed
the
dongie/fix-365
branch
from
850a8ef
to
0a0b086
Compare
dagnir
changed the title
|
@eladb Done |
dagnir
force-pushed
the
dongie/fix-365
branch
from
0a0b086
to
79eb7d6
Compare
eladb
reviewed
Sep 6, 2019
bmaizels
previously approved these changes
Sep 6, 2019
|
Looks good. I've disabled auto-merging so we can get a core member of the CDK team to approve it too. |
mergify
bot
dismissed
bmaizels’s stale review
Pull request has been modified.
This commit enhances javadoc generation for Java classes so that required method/constructor parameters are indicated in their description in the javadoc. This makes it easy for customers to see which paramaters must be provided when interacting with libraries from Java. Fixes aws#365
dagnir
force-pushed
the
dongie/fix-365
branch
from
efb06d7
to
3669e7f
Compare
eladb
previously approved these changes
Sep 8, 2019
| @@ -19,6 +19,8 @@ protected DeprecatedClass(final software.amazon.jsii.JsiiObject.InitializationMo | |||
|
|
|||
| /** | |||
| * @deprecated this constructor is "just" okay | |||
| * @param readonlyString This parameter is required. | |||
| * @param mutableNumber | |||
There was a problem hiding this comment.
shouldn't this say "the value to be set"?
There was a problem hiding this comment.
No, per previous comment from @bmaizels, we only want that description for params on builder setters, not constructors/class methods.
spfink
approved these changes
Sep 9, 2019
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
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.
This commit enhances javadoc generation for Java classes so that required
method/constructor parameters are indicated in their description in the javadoc.
This makes it easy for customers to see which paramaters must be provided when
interacting with libraries from Java.
Fixes #365
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.