Javadoc options for Java classes

Answered

I am trying to configure the Javadoc options to achieve the following:

1. I don't want fully qualified names for native Java classes (String, List, Integer, etc...), I just want the simple name, this is much more readable. I have tried adding the -noqualifier option and change the settings under Code Style > Java > Imports, but I couldn't get to do this.

2. I would want links that take you to the official JDK docs. String, List, and other Java native classes appear blank, with no link. Can this be done?

3. I would like to configure a coherent formatting. For example, my code style defines "chop down when too long" for method arguments, however, when generating the docs, this format is kept and the parameters show up far to the right of the document, making it almost completely unreadable. I don't understand why the docs take the formatting from the code, this should be something different. By the way, this only seems to happen when there's parameter annotations. All the other cases are alright. This is what I mean:

4. How can I change the styles? Right now the font size and style is not as clean as it is in the official JDK docs, it's actually hard to read my docs right now, and kind of ugly (for example, the "code" tag font size is absurdly big).

 

Thanks in advance!

5 comments
Comment actions Permalink

IntelliJ IDEA just calls javadoc tool from JDK. If you want more options, you can call it directly (from external tool, Maven or Ant). Refer to http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html for the documentation.

0
Comment actions Permalink

Yes, I know. But I saw some of these options are configurable from IntelliJ.

This SO question says I can add the -noqualifier option to prevent fully qualified names. I added that to the javadoc arguments and it didn't work.

This other SO question explains how I can configure the options in order not to have fully qualified names. I did that (or the most similar thing for the newer version of IntelliJ) and it didn't take effect.

How about the inconsistent formatting? That must be something that comes from "chop down if too long".

 

This is why I am asking here, asking for help regarding IntelliJ-related questions.

0
Comment actions Permalink

IDE code style doesn't affect the generated JavaDoc. Please try generating from the command line with the options you need.

0
Comment actions Permalink

What about the fully qualified names issue?

0
Comment actions Permalink

Did you add "-noqualifier  all" option? Does it fail from both IDEA and command line JavaDoc tool?

0

Please sign in to leave a comment.