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

Constructor receiving parent type as argument creates error on JavaDoc #146

Closed
HugoMRAmaro opened this issue Feb 13, 2018 · 0 comments
Closed
Labels

Comments

@HugoMRAmaro
Copy link

Hello,

I have a class with a constructor which receives a parent type object, so that I can copy those values to my current instance.
E.g:

public class DatabaseEvent extends BaseEvent {

public DatabaseEvent(BaseEvent baseEvent) {
	super(baseEvent);
}

....
}

The BaseEvent parent constructor is a copy constructor (copies all the object values passed to its instance).

The Builder generated contains a method withBaseEvent(BaseEvent value) but the comments have a link
{@link DatabaseEvent#baseEvent} which is not correct because DatabaseEvent doesn't contain any baseEvent property (and doesn't need)
/**

  • Sets the default value for the {@link DatabaseEvent#baseEvent} property.
  • @param value the default value
  • @return this builder
    */
    public DatabaseEventBuilder withBaseEvent(BaseEvent value) { }

Can it be corrected?
I also tried to find a way to exclude the javadoc generation for this method but I was not able to do it.

Thank you!

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

No branches or pull requests

2 participants