Skip to content

Commit

Permalink
javadoc update
Browse files Browse the repository at this point in the history
  • Loading branch information
zzybluebell committed Nov 4, 2021
1 parent ad6bed6 commit 6307c31
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 32 deletions.
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/model/EzFoodie.java
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public String toString() {
/**
* Overrides and gets member list.
*
* @return ObservableList<Member> a series list data of members.
* @return ObservableList a series list data of members.
*/
@Override
public ObservableList<Member> getMemberList() {
Expand Down
3 changes: 0 additions & 3 deletions src/main/java/seedu/address/model/account/Password.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ public Password(String password) {
value = password;
}

/**
* Returns true if a given string is a valid password.
*/
/**
* Returns true if a given string is a valid password.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ public class IdContainsKeywordsPredicate implements Predicate<Member> {
private final List<String> keywords;

/**
* Constructs a {@code IdContainsKeywordsPredicate} with input {List<String>}.
*
* @param keywords
* Constructs a {@code IdContainsKeywordsPredicate} with input {@code List<String>}.
*/
public IdContainsKeywordsPredicate(List<String> keywords) {
this.keywords = keywords;
Expand Down
28 changes: 13 additions & 15 deletions src/main/java/seedu/address/model/member/Member.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,22 @@ public class Member {
private final List<Transaction> transactions = new ArrayList<>();
private final List<Reservation> reservations = new ArrayList<>();

/**
*
*/

/**
* Constructs {code Member} with follow param.
* Every field must be present and not null.
*
* @param id
* @param name
* @param phone
* @param email
* @param address
* @param timestamp
* @param credit
* @param point
* @param transactions
* @param reservations
* @param tags
* @param id the member id
* @param name the member name
* @param phone the member phone
* @param email the member email
* @param address the member address
* @param timestamp the member timestamp
* @param credit the member credits
* @param point the member point
* @param transactions the member transactions
* @param reservations the member reservations
* @param tags the member tag
*/

public Member(Id id, Name name, Phone phone, Email email, Address address,
Expand Down Expand Up @@ -149,7 +147,7 @@ public Point getPoint() {
* Returns an immutable tag set, which throws {@code UnsupportedOperationException}
* if modification is attempted.
*
* @return Set<Tag>
* @return Set a series of tags
*/
public Set<Tag> getTags() {
return Collections.unmodifiableSet(tags);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,14 @@ public class RegistrationDateContainsKeywordsPredicate implements Predicate<Memb
/**
* Constructs a {@code RegistrationDateContainsKeywordsPredicate} with input {@code List<String>}.
*
* @param keywords
* @param keywords a list of string keywords
*/
public RegistrationDateContainsKeywordsPredicate(List<String> keywords) {
this.keywords = keywords;
}

/**
* Overrides test method.
*
* @param member
* @return boolean
*/
@Override
public boolean test(Member member) {
Expand All @@ -46,15 +43,12 @@ public boolean test(Member member) {
}

/**
* Overrides equals method.
*
* @return boolean
* Overrides the equals method.
*/
@Override
public boolean equals(Object other) {
return other == this // short circuit if same object
|| (other instanceof RegistrationDateContainsKeywordsPredicate // instanceof handles nulls
&& keywords.equals(((RegistrationDateContainsKeywordsPredicate) other).keywords)); // state check
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ public void setMembers(List<Member> members) {
}

/**
* Returns the backing list as an unmodifiable {@code ObservableList}.
* Returns the backing list as an unmodifiable {@code ObservableList<Member>}.
*
* @return ObservableList<Member>
* @return ObservableList a series of oberservation list
*/
public ObservableList<Member> asUnmodifiableObservableList() {
return internalUnmodifiableList;
Expand Down

0 comments on commit 6307c31

Please sign in to comment.