CODEWITHSUNDEEP
javacommand-linejavadoc
Steve Bennett
Steve Bennett

Reputation: 126115

Generic javadoc command that always generates all javadocs in a given tree?

When I have to generate javadocs for a new, unfamiliar project, I find that I spend a long time trying to simply write the correct command, specifying all the packages, all the source trees, etc. It's time-consuming and error-prone: I'm probably missing some source.

So let's say I have a directory myproj, and underneath it there are a few packages (and various other resources and stuff), and under those package directories there are eventually some src/ directories, and then lots of my/awesome/java/project/package type structures.

Is there a single command that will always recurse over EVERYTHING and generate ALL javadocs in one output location? I don't care how long it takes. Something brain-dead like javadoc -d doc -sourcepath . -subpackages * would be great. Failing that, what's the easiest way to generate all javadocs, no matter what the directory structure is?

Upvotes: 24

Views: 10915

Answers (2)

stian
stian

Reputation: 2894

On Windows you can do it like this:

Generate file list: 

dir /s /b *.java > file.lst

Generate javadoc:

javadoc -d outputdir @file.lst

Upvotes: 22

dogbane
dogbane

Reputation: 274542

Use find to find all Java source files and then send them to javadoc:

find . -type f -name "*.java" | xargs javadoc -d outputdir

Upvotes: 39

Related Questions