How to compile javadoc from sources in simplest way?

Question

Suppose I have project directory MyProject, under which I have src directory with sources of the program.

I want to compile all javadocs from there. What is the simplest command to issue?

If I run

javadoc -sourcepath ./src -d ./docs

I get an error

javadoc: error - No packages or classes specified.

Can't it deduce packages from source files?

EDIT 1

This way also causes an error

...MyProject>javadoc -sourcepath ./src *.java -d ./docs
Creating destination directory: "./docs\"
javadoc: error - File not found: "*.java"
1 error

score 23 · Accepted Answer · answered Sep 09 '14 at 17:02

23

The following worked for me

javadoc -sourcepath ./src -d ./docs -subpackages .

answered Sep 09 '14 at 17:02

Suzan Cioc

29,281
63
213
385

score 11 · Answer 2 · answered Apr 03 '12 at 12:28

11

The man page says it will only explicitly document packages that it is given. There is an option called subpackages that recursively documents the given package and all it subpackages, but you must still specify all base packages.

eg.

javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java.net:java.lang

http://www.manpagez.com/man/1/javadoc/

answered Apr 03 '12 at 12:28

Dunes

37,291
7
81
97

3

THe following worked: `javadoc -d ./docs -sourcepath ./src -subpackages org` – Suzan Cioc Apr 03 '12 at 12:35

score 10 · Answer 3 · edited Jan 31 '18 at 18:44

10

In linux, it worked for me when I did the following

javadoc -d docs/ $(find . -name *.java)

I hope this helps

edited Jan 31 '18 at 18:44

Lajos Arpad

64,414
37
100
175

answered Sep 05 '14 at 13:37

kholofelo Maloma

973
3
15
26

1

Worked for me! I had to add a . to the find command: `find . -name *.java`. – Mike Jeffrey Aug 18 '16 at 19:01
How about generating the javadocs within a project with multiple directories and packages not within the root path? My find command can find it, but I receive X number of errors depending on the number of X source files. – Joyoyoyoyoyo Aug 30 '18 at 17:49

score 3 · Answer 4 · answered Apr 03 '12 at 12:27

3

try using javadoc -sourcepath ./src *.java -d ./docs

answered Apr 03 '12 at 12:27

Rahul Borkar

2,742
3
24
38

P.S. of course there are a lot of java files under `src` actually. – Suzan Cioc Apr 03 '12 at 12:29
1

This won't include subpackages and `*.java` should be `**/*.java`. – Paul Apr 01 '19 at 21:21

score 3 · Answer 5 · answered Apr 03 '12 at 12:37

3

The lazy way is to use Eclipse : Project --> GenerateJavadoc and choose the package/project you want to document.

answered Apr 03 '12 at 12:37

cl-r

1,264
1
12
26

score 0 · Answer 6 · answered Aug 26 '17 at 15:50

0

For me also the following worked:

javadoc -sourcepath ./src **/*.java -d ./docs

answered Aug 26 '17 at 15:50

derwiwie

875
10
16

How to compile javadoc from sources in simplest way?

6 Answers6