Home

Javadoc Demo 🚀

Explore how to write, generate, and host beautiful API docs using the Javadoc tool in Java.

---

Welcome to the Javadoc-Demo Wiki

This wiki complements the javadoc-demo repository, which showcases how to generate HTML API documentation using the Javadoc tool in Java.

Whether you're just getting started or brushing up your Java documentation skills, this guide is here to help!

---

What You’ll Learn

• ✅ What Javadoc is and why it's used

• ✅ How to write Javadoc comments

• ✅ How to generate Javadoc HTML files

• ✅ How to host Javadoc with GitHub Pages

• ✅ Best practices for clean API documentation

---

Project Structure

Javadoc-Demo/
├── src/
│   └── com/kapil/javadocdemo/JavadocDemo.java
├── docs/
│   ├── index.html              # Generated Javadoc entry point
│   └── other Javadoc files
├── assets/                     # Sample Screenshots used in README
├── README.md

---

Quick Start

To generate documentation from the terminal:

javadoc -d docs src/com/kapil/javadocdemo/JavadocDemo.java

To view the generated docs, open:

docs/index.html

Want to Share It Online?

You can host your Javadoc documentation using GitHub Pages — a free and easy way to publish it for public access. 🌍

Want to see how it looks once hosted?

• 👉 View the Live Demo – Hosted Javadoc Documentation

---

Feedback

Have suggestions or found a bug? Feel free to open an issue or contribute to improve this project!

---