Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-12 08:25:44 +01:00
Code Issues Packages Projects Releases Activity

improve javadoc of Person class

Browse Source
This commit is contained in:
Sebastian Sdorra
2011-10-04 19:25:56 +02:00
parent d2cc54451c
commit d3075a1935
1 changed files with 24 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
scm-core/src/main/java/sonia/scm/repository/Person.java
View File

@@ -46,7 +46,7 @@ import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement; import javax.xml.bind.annotation.XmlRootElement;
/** /**
* the person (author) of a changeset * The {@link Person} (author) of a changeset.
* *
* @person Sebastian Sdorra * @person Sebastian Sdorra
*/ */
@@ -56,16 +56,17 @@ public class Person implements Validateable
{ {
/** /**
* Constructs ... * Constructs a new {@link Person}.
* This constructor is used by JAXB.
* *
*/ */
public Person() {} public Person() {}
/** /**
* Constructs ... * Constructs a new {@link Person}.
* *
* *
* @param name * @param name name of {@link Person}
*/ */
public Person(String name) public Person(String name)
{ {
@@ -73,11 +74,11 @@ public class Person implements Validateable
} }
/** /**
* Constructs ... * Constructs a new {@link Person} with name and mail address.
* *
* *
* @param name * @param name name of the {@link Person}
* @param mail * @param mail mail address of the {@link Person}
*/ */
public Person(String name, String mail) public Person(String name, String mail)
{ {
@@ -88,12 +89,14 @@ public class Person implements Validateable
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
* Method description * Parses the given string and returns a {@link Person} object. The string
* should be in the format "name >mail<". if the string contains no
* "><" the whole string is handled as the name of the {@link Person}.
* *
* *
* @param value * @param value string representation of a {@link Person} object
* *
* @return * @return {@link Person} object which is generated from the given string
*/ */
public static Person toPerson(String value) public static Person toPerson(String value)
{ {
@@ -119,10 +122,11 @@ public class Person implements Validateable
} }
/** /**
* Method description * Returns a string representation of the {@link Person} object,
* in the format "name >mail<".
* *
* *
* @return * @return string representation of {@link Person} object
*/ */
@Override @Override
public String toString() public String toString()
@@ -140,10 +144,10 @@ public class Person implements Validateable
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* returns the mail address of the changeset person * Returns the mail address of the changeset author.
* *
* *
* @returnmail address of the changeset person * @return mail address of the changeset author
* *
* @return * @return
*/ */
@@ -153,7 +157,7 @@ public class Person implements Validateable
} }
/** /**
* return the name of the changeset person * Returns the name of the changeset author.
* *
* *
* @return name of the changeset person * @return name of the changeset person
@@ -164,7 +168,7 @@ public class Person implements Validateable
} }
/** /**
* returns true if the person is valid * Returns true if the person is valid.
* *
* *
* @return true if the person is valid * @return true if the person is valid
@@ -179,10 +183,10 @@ public class Person implements Validateable
//~--- set methods ---------------------------------------------------------- //~--- set methods ----------------------------------------------------------
/** /**
* sets the mail address of the changeset person * Sets the mail address of the changeset author.
* *
* *
* @param mail * @param mail mail address of the author
*/ */
public void setMail(String mail) public void setMail(String mail)
{ {
@@ -190,10 +194,10 @@ public class Person implements Validateable
} }
/** /**
* sets the name of the changeset person * Sets the name of the changeset author.
* *
* *
* @param name * @param name name of the author
*/ */
public void setName(String name) public void setName(String name)
{ {