Skip to content

chore[README]: add guide to generate and access javadoc html #83

Merged
merged 2 commits into from
Apr 24, 2026
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ The project uses the standard Maven directory structure, which ensures:
**Run From JAR: (Windows)**

1. Download Project JAR:
Go to repository and download the JAR.
Go to repository and download the JAR from the jar release.

2. Run the JAR in Terminal:

Expand Down Expand Up @@ -273,6 +273,19 @@ Each report includes:
3. Execution times
4. Running tests in an IDE

## Accessing the javadocs
The javadoc can be generated and accessed using the following commands.

1. Generate the Javadoc HTML
```bash
mvn javadoc:javadoc
```
```
```

2. Open the HTML file
open ```target/reports/apidocs/index.html```

## References 🔗

For more references and project details, kindly refer yourself to the project report and Wiki pages
Expand Down