Skip to content
Snippets Groups Projects
Commit ed6afa07 authored by tmnaqeesha's avatar tmnaqeesha
Browse files

doc: Improve javadoc comments

parent f3ef99a6
No related branches found
No related tags found
2 merge requests!8Improve javadoc comments,!6Code cleanup
package opinion;
/**
* This class allows us to create books and to register new books
* <h3>A class that allows us to create books and to register new books</h3>
*
* @author Maryam TENGKU
* @author Neva MASSY
* @version 1.0
* @since 1.0
*/
public class Book {
//Declaration of private class variables
/**
* Declaration of private class variables : book title, kind and author
*/
private String title, kind, author, comment;
private int nbPages;
/**
* Initialization of private variables with constructor
* <b>Initialization of private variables with constructor</b>
*
* @param title The title of the book
* @param kind The type of the book
......@@ -25,7 +33,7 @@ public class Book {
}
/**
* Return the title of the book
* <b>Return the title of the book</b>
*
* @return book's title
*/
......@@ -34,7 +42,7 @@ public class Book {
}
/**
* Return the kind of the book
* <b>Return the kind of the book</b>
*
* @return book's kind
*/
......@@ -43,7 +51,7 @@ public class Book {
}
/**
* Retrieve the author of the book
* <b>Retrieve the author of the book</b>
*
* @return book's author
*/
......@@ -52,7 +60,7 @@ public class Book {
}
/**
* Return the number of pages of the book
* <b>Return the number of pages of the book</b>
*
* @return book's page number
*/
......@@ -61,7 +69,7 @@ public class Book {
}
/**
* Identify if the current book's title is similar as another book
* <b>Identify if the current book's <i>title</i> is similar as another book</b>
*
* @param title2 other's book's title
* @return true if same, false if different
......@@ -73,7 +81,7 @@ public class Book {
}
/**
* String function to display the details of a book
* <b>String function to display the details of a book</b>
*
* @return the book's details
*/
......
......@@ -2,8 +2,8 @@ package opinion;
/**
* This class allows us to create and register new members
* A member has a login, a password and a profile that he has to register before connecting to the site
* <h3>A class that allows us to create and register new members</h3>
* A member has a <i>login</i>, a ,<i>password</i> and a <i>profile</i> that they have to register before connecting to the site
*
* @author Maryam TENGKU
* @author Neva MASSY
......@@ -13,12 +13,12 @@ package opinion;
public class Member {
/**
* Declaration of member's login, password and profile.
* Declaration of private class variables : member's login, password and profile.
*/
private String login, password, profile;
/**
* Construct new Member with specified login, password and profile.
* <b>Construct new Member with specified login, password and profile.</b>
*
* @param login member's login
* @param password member's password
......@@ -31,7 +31,7 @@ public class Member {
}
/**
* Returns member's login
* <b>Returns member's login</b>
*
* @return login
*/
......@@ -40,7 +40,7 @@ public class Member {
}
/**
* Returns member's password
* <b>Returns member's password</b>
*
* @return password
*/
......@@ -50,7 +50,7 @@ public class Member {
/**
* Returns member's profile
* <b>Returns member's profile</b>
*
* @return profile
*/
......@@ -60,7 +60,7 @@ public class Member {
/**
* String function to display details of a member (login and profile)
* <b>String function to display details of a member (<i>login</i> and <i>profile</i>)</b>
*
* @return string of details of a member
*/
......
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment