You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This feature is not working for getter and setter (any more).
Currently only @param tags will be created, only for constructors. JDocComment#addParam( String) will only be called in ConstructorRule. JDocComment#addReturn() will never be called.
title and descrition will currently be used in the Javadoc for getter and setter, but not as @param and @retrun tags, e.g.:
/**
* Titel of the property
* <p>
* Description of the property
* (Required)
*
*/
public Type getProperty() {
return property;
}
/**
* Titel of the property
* <p>
* Description of the property
* (Required)
*
*/
public void setProperty(Type property) {
this.property = property;
}
It should be something like this:
/**
* Gets the Titel of the property.
* <p>
* Description of the property
* (Required)
*
* @return the Titel of the property
*/
public Type getProperty() {
return property;
}
/**
* Sets the Titel of the property.
* <p>
* Description of the property
* (Required)
*
* @param property
* Titel of the property
*/
public void setProperty(Type property) {
this.property = property;
}
N.B.: IMHO it would be sufficient to use only the title (if exists, otherwise the description) for the tags, but the current solution used for @param tags at constructors (title + . + description) is fine too.
@param and @retrun tags, including the title (and/or maybe description), should be added to getter and setter.
The text was updated successfully, but these errors were encountered:
By issue 218 (Generate @Param and @Returns javadoc) (pull request 219)
@param
and@retrun
tags have been added.This feature is not working for getter and setter (any more).
Currently only
@param
tags will be created, only for constructors.JDocComment#addParam( String)
will only be called in ConstructorRule.JDocComment#addReturn()
will never be called.title
anddescrition
will currently be used in the Javadoc for getter and setter, but not as@param
and@retrun
tags, e.g.:It should be something like this:
N.B.: IMHO it would be sufficient to use only the
title
(if exists, otherwise thedescription
) for the tags, but the current solution used for@param
tags at constructors (title
+.
+description
) is fine too.@param
and@retrun
tags, including thetitle
(and/or maybedescription
), should be added to getter and setter.The text was updated successfully, but these errors were encountered: