-
Notifications
You must be signed in to change notification settings - Fork 243
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(java): Indicate if method param is required #762
Conversation
...lc/java/src/main/java/software/amazon/jsii/tests/calculator/UsesInterfaceWithProperties.java
Outdated
Show resolved
Hide resolved
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? |
...cted.jsii-calc/java/src/main/java/software/amazon/jsii/tests/calculator/UnionProperties.java
Outdated
Show resolved
Hide resolved
a15666f
to
019ee3c
Compare
Please fix PR title and add rationale in description |
850a8ef
to
0a0b086
Compare
@eladb Done |
0a0b086
to
79eb7d6
Compare
Looks good. I've disabled auto-merging so we can get a core member of the CDK team to approve it too. |
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
efb06d7
to
3669e7f
Compare
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't this say "the value to be set"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, per previous comment from @bmaizels, we only want that description for params on builder setters, not constructors/class methods.
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
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.