Remove unnecessary javadoc from test code if method signature is self-described

Closes: #3332

Author: quaff

spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/AuditableUser.java

@@ -57,33 +57,19 @@ public AuditableUser(@Nullable Integer id, String firstname) {
 		this.firstname = firstname;
 	}
 
-	/**
-	 * Returns the firstname.
-	 *
-	 * @return the firstname
-	 */
 	public String getFirstname() {
-
 		return firstname;
 	}
 
-	/**
-	 * Sets the firstname.
-	 *
-	 * @param firstname the firstname to set
-	 */
 	public void setFirstname(final String firstname) {
-
 		this.firstname = firstname;
 	}
 
 	public void addRole(AuditableRole role) {
-
 		this.roles.add(role);
 	}
 
 	public Set<AuditableRole> getRoles() {
-
 		return roles;
 	}
 }

spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Child.java

@@ -33,9 +33,6 @@ public class Child {
 	@ManyToMany(mappedBy = "children")
 	Set<Parent> parents = new HashSet<>();
 
-	/**
-	 * @param parent
-	 */
 	public Child add(Parent parent) {
 
 		this.parents.add(parent);

spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/Role.java

@@ -33,50 +33,26 @@ public class Role {
 	@Id @GeneratedValue private Integer id;
 	private String name;
 
-	/**
-	 * Creates a new instance of {@code Role}.
-	 */
 	public Role() {}
 
-	/**
-	 * Creates a new preconfigured {@code Role}.
-	 *
-	 * @param name
-	 */
 	public Role(final String name) {
 		this.name = name;
 	}
 
-	/**
-	 * Returns the id.
-	 *
-	 * @return
-	 */
 	public Integer getId() {
-
 		return id;
 	}
 
-	/**
-	 * @return the name
-	 */
 	public String getName() {
 		return name;
 	}
 
 	@Override
 	public String toString() {
-
 		return PREFIX + name;
 	}
 
-	/**
-	 * Returns whether the role is to be considered new.
-	 *
-	 * @return
-	 */
 	public boolean isNew() {
-
 		return id == null;
 	}
 }

spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/SampleWithPrimitiveId.java

@@ -26,9 +26,6 @@ public class SampleWithPrimitiveId {
 
 	@Id private long id;
 
-	/**
-	 * @param id the id to set
-	 */
 	public void setId(long id) {
 		this.id = id;
 	}

spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/User.java

@@ -115,21 +115,10 @@ public class User {
 
 	@Temporal(TemporalType.DATE) private Date dateOfBirth;
 
-	/**
-	 * Creates a new empty instance of {@code User}.
-	 */
 	public User() {
 		this(null, null, null);
 	}
 
-	/**
-	 * Creates a new instance of {@code User} with preinitialized values for firstname, lastname, email address and roles.
-	 *
-	 * @param firstname
-	 * @param lastname
-	 * @param emailAddress
-	 * @param roles
-	 */
 	public User(String firstname, String lastname, String emailAddress, Role... roles) {
 
 		this.firstname = firstname;
@@ -142,222 +131,119 @@ public User(String firstname, String lastname, String emailAddress, Role... role
 		this.createdAt = new Date();
 	}
 
-	/**
-	 * @return the id
-	 */
 	public Integer getId() {
-
 		return id;
 	}
 
-	/**
-	 * @param id the id to set
-	 */
 	public void setId(Integer id) {
-
 		this.id = id;
 	}
 
-	/**
-	 * Returns the firstname.
-	 *
-	 * @return the firstname
-	 */
 	public String getFirstname() {
-
 		return firstname;
 	}
 
-	/**
-	 * Sets the firstname.
-	 *
-	 * @param firstname the firstname to set
-	 */
 	public void setFirstname(final String firstname) {
-
 		this.firstname = firstname;
 	}
 
-	/**
-	 * Returns the lastname.
-	 *
-	 * @return the lastname
-	 */
 	public String getLastname() {
-
 		return lastname;
 	}
 
-	/**
-	 * Sets the lastname.
-	 *
-	 * @param lastname the lastname to set
-	 */
 	public void setLastname(String lastname) {
-
 		this.lastname = lastname;
 	}
 
-	/**
-	 * @return the age
-	 */
 	public int getAge() {
 		return age;
 	}
 
-	/**
-	 * @param age the age to set
-	 */
 	public void setAge(int age) {
 		this.age = age;
 	}
 
-	/**
-	 * Returns the email address.
-	 *
-	 * @return the emailAddress
-	 */
 	public String getEmailAddress() {
 
 		return emailAddress;
 	}
 
-	/**
-	 * Sets the email address.
-	 *
-	 * @param emailAddress the emailAddress to set
-	 */
 	public void setEmailAddress(String emailAddress) {
 
 		this.emailAddress = emailAddress;
 	}
 
-	/**
-	 * @param active the active to set
-	 */
 	public void setActive(boolean active) {
 		this.active = active;
 	}
 
-	/**
-	 * @return the active
-	 */
 	public boolean isActive() {
 		return active;
 	}
 
-	/**
-	 * Returns the user's roles.
-	 *
-	 * @return the roles
-	 */
 	public Set<Role> getRoles() {
 
 		return roles;
 	}
 
-	/**
-	 * Gives the user a role. Adding a role the user already owns is a no-op.
-	 */
 	public void addRole(Role role) {
 
 		roles.add(role);
 	}
 
-	/**
-	 * Revokes a role from a user.
-	 *
-	 * @param role
-	 */
 	public void removeRole(Role role) {
 
 		roles.remove(role);
 	}
 
-	/**
-	 * Returns the colleagues of the user.
-	 *
-	 * @return the colleagues
-	 */
 	public Set<User> getColleagues() {
 
 		return colleagues;
 	}
 
-	/**
-	 * Adds a new colleague to the user. Adding the user himself as colleague is a no-op.
-	 *
-	 * @param collegue
-	 */
-	public void addColleague(User collegue) {
+	public void addColleague(User colleague) {
 
 		// Prevent from adding the user himself as colleague.
-		if (this.equals(collegue)) {
+		if (this.equals(colleague)) {
 			return;
 		}
 
-		colleagues.add(collegue);
-		collegue.getColleagues().add(this);
+		colleagues.add(colleague);
+		colleague.getColleagues().add(this);
 	}
 
-	/**
-	 * Removes a colleague from the list of colleagues.
-	 *
-	 * @param colleague
-	 */
 	public void removeColleague(User colleague) {
 
 		colleagues.remove(colleague);
 		colleague.getColleagues().remove(this);
 	}
 
-	/**
-	 * @return the manager
-	 */
 	public User getManager() {
 
 		return manager;
 	}
 
-	/**
-	 * @param manager the manager to set
-	 */
 	public void setManager(User manager) {
 
 		this.manager = manager;
 	}
 
-	/**
-	 * @return the createdAt
-	 */
 	public Date getCreatedAt() {
 		return createdAt;
 	}
 
-	/**
-	 * @return the address
-	 */
 	public Address getAddress() {
 		return address;
 	}
 
-	/**
-	 * @param address the address to set
-	 */
 	public void setAddress(Address address) {
 		this.address = address;
 	}
 
-	/**
-	 * @param binaryData the binaryData to set
-	 */
 	public void setBinaryData(byte[] binaryData) {
 		this.binaryData = binaryData;
 	}
 
-	/**
-	 * @return the binaryData
-	 */
 	public byte[] getBinaryData() {
 		return binaryData;
 	}
@@ -378,16 +264,10 @@ public boolean equals(Object obj) {
 		return this.getId().equals(that.getId());
 	}
 
-	/**
-	 * @return the attributes
-	 */
 	public Set<String> getAttributes() {
 		return attributes;
 	}
 
-	/**
-	 * @param attributes the attributes to set
-	 */
 	public void setAttributes(Set<String> attributes) {
 		this.attributes = attributes;
 	}
@@ -406,7 +286,6 @@ public void setCreatedAt(Date createdAt) {
 
 	@Override
 	public String toString() {
-
 		return "User: " + getId() + ", " + getFirstname() + " " + getLastname() + ", " + getEmailAddress();
 	}
 }