Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
fip112-2025-g41
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
BINTI TENGKU MASRULHISHAM Tengku Maryam Naqeesha
fip112-2025-g41
Commits
ed6afa07
Commit
ed6afa07
authored
1 month ago
by
tmnaqeesha
Browse files
Options
Downloads
Patches
Plain Diff
doc: Improve javadoc comments
parent
f3ef99a6
No related branches found
No related tags found
2 merge requests
!8
Improve javadoc comments
,
!6
Code cleanup
Changes
3
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
src/opinion/Book.java
+17
-9
17 additions, 9 deletions
src/opinion/Book.java
src/opinion/Member.java
+8
-8
8 additions, 8 deletions
src/opinion/Member.java
src/tests/AddMemberTest.java
+285
-303
285 additions, 303 deletions
src/tests/AddMemberTest.java
with
310 additions
and
320 deletions
src/opinion/Book.java
+
17
−
9
View file @
ed6afa07
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
*/
...
...
This diff is collapsed.
Click to expand it.
src/opinion/Member.java
+
8
−
8
View file @
ed6afa07
...
...
@@ -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 ha
s
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
t
he
y
ha
ve
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.
Click to expand it.
src/tests/AddMemberTest.java
+
285
−
303
View file @
ed6afa07
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment