---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# javadoc

> Generate Java API documentation in HTML format from source code.
> More information: <https://docs.oracle.com/en/java/javase/25/docs/specs/man/javadoc.html>.

- Generate documentation for Java source code and save the result in a directory:

`javadoc -d {{path/to/directory}}/ {{path/to/java_source_code}}`

- Generate documentation with a specific encoding:

`javadoc -docencoding {{UTF-8}} {{path/to/java_source_code}}`

- Generate documentation excluding some packages:

`javadoc -exclude {{package_list}} {{path/to/java_source_code}}`
