Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Why IDEA shows JavaDoc as error?

/**
     * @param string
     * @throws ApplicationException
     */

IDEA highlight the 'string' and tells "No documentation found". Why is that so?

like image 1000
Eugene Avatar asked Nov 28 '12 11:11

Eugene


People also ask

How do I use Javadoc in IntelliJ?

From the main menu, select Tools | Generate JavaDoc. In the dialog that opens, select a scope — a set of files or directories for which you want to generate the reference, and set the output directory where the generated documentation will be placed.

How do I run a Javadoc?

To generate JavaDoc in Eclipse: –Select “Generate JavaDoc” option from Project menu and a wizard will appear. Specify the location for the JavaDoc file on your computer, by default it will be in the C drive. Select the project and then the packages for which you want to create the JavaDoc file.

What is a Javadoc in Java?

Javadoc (originally cased JavaDoc) is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code.


2 Answers

Write some documentation for the string param or adjust the Declaration has Javadoc problems inspection settings so that such problems are not reported:

Declaration has Javadoc problems

like image 185
CrazyCoder Avatar answered Oct 20 '22 19:10

CrazyCoder


My development tools is Android Studio, I meet the problem like you.
You just do it like so.

From File => Settings

enter image description here

like image 34
Longalei Avatar answered Oct 20 '22 18:10

Longalei