Skip to content
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

Remove useless and empty Javadoc #659

Closed
jlupi opened this issue Dec 9, 2016 · 7 comments
Closed

Remove useless and empty Javadoc #659

jlupi opened this issue Dec 9, 2016 · 7 comments
Milestone

Comments

@jlupi
Copy link

jlupi commented Dec 9, 2016

Hi

The generated javadoc is useless if no description is provided in the json schema.
Additionally an empty javadoc appears on properties which doesnt make sense.

"via": {
   "type": "string"
},
/**
 * 
 */
private String via;

/**
 * 
 * @return
 *     The via
 */
public String getVia() {
     return via;
}

/**
 * 
 * @param via
 *     The via
 */
public void setVia(String via) {
    this.via = via;
}

For such cases the javadoc generation should be disabled.

Aditionally a toggle could be added for the javadoc generation.

@joelittlejohn
Copy link
Owner

Yes agreed. I feel like this is a problem that hasn't always existed.

Let's definitely sort this out for the next version. I'm not interested in adding a config property for this, the javadoc just shouldn't be added if there is no useful information.

@joelittlejohn
Copy link
Owner

It looks like the empty javadoc has been introduced for all fields by #645.

@joelittlejohn
Copy link
Owner

The @param and @return were added to avoid Javadoc warnings in Java 8 by 6e5ace7. I would prefer to remove these as this is useless noise in the source code.

@joelittlejohn joelittlejohn changed the title Add toggle for javadoc generation Remove useless and empty Javadoc Dec 13, 2016
@joelittlejohn joelittlejohn added this to the 0.4.29 milestone Dec 13, 2016
@jlupi
Copy link
Author

jlupi commented Dec 13, 2016

@joelittlejohn I fully agree. Thanks.

@annawinkler
Copy link

Without the javadoc being generated, there are warnings in Java 8 for missing @return and @param docs. What's the workaround for that?

@joelittlejohn
Copy link
Owner

@annawinkler
Copy link

annawinkler commented Mar 6, 2017 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants