Project
IntelliJ IDEA
Priority
Normal
Type
Bug
Fix versions
No Fix versions
State
Fixed
Assignee
Anna Kozlova
Subsystem
Code Analysis. Inspection
Affected versions
No Affected versions
Fixed in build
108.65  
  • Created by   Michael Besosa
    5 years ago (01 Aug 2006 17:22)
  • Updated by   root
    2 years ago (17 Jan 2010 20:31)
  • Jira: IDEADEV-8874
    (history, comments)
 
IDEA-33150 Faulty inspection results for malformed javadoc @link tags
0
Issue is visible to: All Users
  The issue is visible to the selected user group only
Given the following javadoc (note the missing opening curly brace in the @linkplain tag):
/**
* Denotes exit from a
* @linkplain #enterCriticalSection() critical section}. If
* {@link #stop()} was invoked on this job while it was in the critical
* section, invoking this method will cause the job's execution thread to
* be interrupted. Effectively, the interruption generated by the stop
* request is delayed until exit from the critical section.<p>
*
* If this job is not in a critical section, invocation of this operation
* has no effect.
*/

protected final synchronized void exitCriticalSection() {...}

IDEA reports "Period in the documentation is missing". In other cases (methods that have non-void returns), missing opening or closing braces cause reports that "Required tag '@return' is missing", instead of identifying the real problem.

In general, the javadoc inspections don't do a good job with embedded tags: The two most common errors–missing parameter lists in @link and @linkplain tags and mistyping a parenthesis for a brace are either not reported at all or (as in the example above) misreported.


Issue was resolved
Comments (0)
 
History
 
Linked Issues (?)
 
Issue has no comments