fix(java): add javadoc to all methods APIC-538 #704
Conversation
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
millotp
requested review from
a team,
damcou and
shortcuts
and removed request for
a team
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
| @@ -155,19 +155,35 @@ public class {{classname}} extends ApiClient { | |||
| } | |||
|
|
|||
| {{! This case only sets `requestOptions` as optional }} | |||
| /** | |||
| * {{¬es}}{{#allParams}} | |||
| * @param {{paramName}} {{&description}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#returnType}} | |||
There was a problem hiding this comment.
| * @param {{paramName}} {{&description}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#returnType}} | |
| * @param {{paramName}} {{&description}} {{#required}}(required){{/required}}{{/allParams}}{{#returnType}} |
wdyt?
There was a problem hiding this comment.
when it's optional that mean we can pass null and it will take the default value on the engine, I should add @Nullable annotations also.
If I put (required) everywhere might as well put it no where right ?
There was a problem hiding this comment.
If I put (required) everywhere might as well put it no where right ?
It's more about putting it only where it's required, which was explicit enough to me, but it's up to you! (We can still remove the default to)
There was a problem hiding this comment.
why do you want to remove the default to ?
There was a problem hiding this comment.
isn't it the API default? It seems confusing to have it here
There was a problem hiding this comment.
yeah it's the api default, the same way we have it in the doc, I think it's okay to say it in the javadoc too
| */ |
There was a problem hiding this comment.
can you remove the newline pls?
🧭 What and Why
🎟 JIRA Ticket: APIC-538
Add the javadoc everywhere because we can and it's very useful when hovering methods.
🧪 Test
Hover a method in your favorite IDE