History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: IDEADEV-8874
Type: Bug Bug
Status: Resolved Resolved
Resolution: Fixed
Priority: Normal Normal
Assignee: Anna Kozlova
Reporter: Michael Besosa
Votes: 0
Watchers: 1
Operations

If you were logged in you would be able to see more operations.
IDEA: Development

Faulty inspection results for malformed javadoc @link tags

Created: 01 Aug 06 16:22   Updated: 06 Dec 07 18:52
Component/s: Code Analysis. Inspection
Fix Version/s: Selena 7.0.2

Original Estimate: Unknown Remaining Estimate: Unknown Time Spent: Unknown
Issue Links:
Duplicate
 
This issue is duplicated by:
IDEADEV-20730 Wrong inspection reporting for missin... Normal Closed

Build: 5,581
Fixed in build: 7,523
Severity: Medium


 Description  « Hide
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.



 All   Comments   Work Log   Change History      Sort Order:
There are no comments yet on this issue.