Adding javadoc compatible comments and new documentation

bibo7086 · May 7, 2023 · d87e601 · d87e601
1 parent bcd3a6b
commit d87e601
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -33,7 +33,8 @@ If you want to contribute:
 
 ## Code Documentation
 
-[Kademlia draft documentation](simulator/src/main/java/peersim/kademlia/docs/apidocs/index.html) 
+
+[Kademlia draft documentation](simulator/src/main/java/peersim/kademlia/docs/kademlia_draft_doc.md) 
 
 ## How to create a protocol on top of Kademlia
 

diff --git a/simulator/src/main/java/peersim/kademlia/docs/kademlia_draft_doc.md b/simulator/src/main/java/peersim/kademlia/docs/kademlia_draft_doc.md
@@ -15,8 +15,7 @@ Apart from the KademliaProtocol class many other classes are used, but two are i
 
 ### **3. Class and Method Description**
 
-Before adopting Javadoc, the following descriptions were written for the classes and methods in the **`KademliaProtocol`** Class. The javadoc generated documentation can be found [here](../docs/apidocs/index.html). 
-
+Before adopting Javadoc, the following descriptions were written for the classes and methods in the **`KademliaProtocol`** Class. The javadoc generated documentation can be found in the apidocs subfolder within the docs folder [here](../docs/apidocs/) (or following ../docs/apidocs/). 
 
 The primary/main class is the **`KademliaProtocol`** class, which implements the **`EDProtocol`** interface. It has several instance variables, including `nodeId`, which represents the ID of the node running the protocol; `routingTable`, which is the routing table for the node; and `sentMsg` and `findOp`, which are data structures used to keep track of messages sent and find operations, respectively.