Using the IDEA editor - IntelliJ IDEA in Action - page 79

with JavaDoc should be considered errors or warnings (or ignored) as well as
tell IDEA about any custom JavaDoc tags you're using. IDEA 's refactoring tools
(see chapter 9) will even keep your JavaDoc in sync if you rename method
parameters or otherwise alter the method signature.

Code completion (described in the next section) also works on both
standard and custom JavaDoc attributes. You can use the code inspec-
tion tool described in chapter 9 to search for missing JavaDoc across
your project.

TIP

As soon as you have your new JavaDoc block, it becomes immediately available
via the Quick JavaDoc command, described earlier. Just position the caret at
the method name, and press Ctrl+Q : The newly created JavaDoc will be
opened for review.

3.5.4 Generating your project's JavaDoc reference

IDEA provides a graphical front-end to the standard JavaDoc tool, allowing you
to generate your project's JavaDoc. Execute the Tools | Generate JavaDoc
command to bring up the Generate JavaDoc window, as shown in figure 3.9.
You can elect to generate JavaDoc for the entire project (all source trees) or for
a particular package. The Scope slider determines what level of documentation

Figure 3.9
IDEA's Generate JavaDoc
window provides an easy inter-
face for configuring how your
JavaDoc API documentation
should be created.