From b95ec365a5d1aafbaf81c2a574cf219ccf8bd21b Mon Sep 17 00:00:00 2001 From: Ein Verne Date: Wed, 20 Nov 2019 01:01:14 +0800 Subject: [PATCH] javadoc: add page (#3567) --- pages/common/javadoc.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 pages/common/javadoc.md diff --git a/pages/common/javadoc.md b/pages/common/javadoc.md new file mode 100644 index 0000000000..7dff29c9fe --- /dev/null +++ b/pages/common/javadoc.md @@ -0,0 +1,16 @@ +# javadoc + +> Generate Java API documentation in HTML format from source code. +> More information: . + +- 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}}`