Skip to content

Commit 7e8acad

Browse files
committed
#1596:Updated Java Docs and README.md
1 parent fc35305 commit 7e8acad

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

slob/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ tag:
1616

1717
## Explanation
1818

19-
* Forest here represents the object graph.
19+
* The Forest here represents the object graph.
2020
* A forest contains animals and plants. As is in real life the forest object contains plants and
2121
animals
2222
where some animals eat other animals and some eat only plants.

slob/src/main/java/com/iluwatar/slob/App.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ public static void main(String[] args) throws SQLException {
6666

6767
/**
6868
* Creates a Forest with Animals and Plants along with their respective relationships.
69+
* <p> The method creates a forest with 2 Plants Grass and Oak of type Herb and tree
70+
* respectively.</p>
71+
* <p> It also creates 3 animals Zebra and Buffalo which eat the plant grass. Lion consumes the
72+
* Zebra and the Buffalo.</p>
73+
* <p>With the above animals and plants and their relationships a forest
74+
* object is created which represents the Object Graph.</p>
6975
*
7076
* @return Forest Object
7177
*/

slob/src/test/java/com/iluwatar/slob/AppTest.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,13 @@
5050
class AppTest {
5151

5252
/**
53-
* Creates a Forest with Animals and Plants along with their respective relationships
53+
* Creates a Forest with Animals and Plants along with their respective relationships.
54+
* <p> The method creates a forest with 2 Plants Grass and Oak of type Herb and tree
55+
* respectively.</p>
56+
* <p> It also creates 3 animals Zebra and Buffalo which eat the plant grass. Lion consumes the
57+
* Zebra and the Buffalo.</p>
58+
* <p>With the above animals and plants and their relationships a forest
59+
* object is created which represents the Object Graph.</p>
5460
*
5561
* @return Forest Object
5662
*/

0 commit comments

Comments
 (0)