Skip to content

Commit

Permalink
#1596:Updated Java Docs and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KishalayP committed Jan 21, 2024
1 parent fc35305 commit 7e8acad
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion slob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ tag:

## Explanation

* Forest here represents the object graph.
* The Forest here represents the object graph.
* A forest contains animals and plants. As is in real life the forest object contains plants and
animals
where some animals eat other animals and some eat only plants.
Expand Down
6 changes: 6 additions & 0 deletions slob/src/main/java/com/iluwatar/slob/App.java
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ public static void main(String[] args) throws SQLException {

/**
* Creates a Forest with Animals and Plants along with their respective relationships.
* <p> The method creates a forest with 2 Plants Grass and Oak of type Herb and tree
* respectively.</p>
* <p> It also creates 3 animals Zebra and Buffalo which eat the plant grass. Lion consumes the
* Zebra and the Buffalo.</p>
* <p>With the above animals and plants and their relationships a forest
* object is created which represents the Object Graph.</p>
*
* @return Forest Object
*/
Expand Down
8 changes: 7 additions & 1 deletion slob/src/test/java/com/iluwatar/slob/AppTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,13 @@
class AppTest {

/**
* Creates a Forest with Animals and Plants along with their respective relationships
* Creates a Forest with Animals and Plants along with their respective relationships.
* <p> The method creates a forest with 2 Plants Grass and Oak of type Herb and tree
* respectively.</p>
* <p> It also creates 3 animals Zebra and Buffalo which eat the plant grass. Lion consumes the
* Zebra and the Buffalo.</p>
* <p>With the above animals and plants and their relationships a forest
* object is created which represents the Object Graph.</p>
*
* @return Forest Object
*/
Expand Down

0 comments on commit 7e8acad

Please sign in to comment.