k4zy / doclava

Automatically exported from code.google.com/p/doclava
Apache License 2.0
0 stars 0 forks source link

Inaccurate line numbers #11

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago
As reported as internal issue 2915165 by enh,

Given this, where the first quoted line is line 25, doclava will complain

frameworks/base/../../libcore/luni/src/main/java/java/util/TimeZone.java:25: 
error 1: Unresolved link/see tag "SimpleDateFormat" in java.util.TimeZone

though the error is actually 14 lines further on. this is confusing.

 * {@code TimeZone} represents a time zone, primarily used for configuring a {@link Calendar} or
 * {@link java.text.SimpleDateFormat} instance.
 *
 * <p>Most applications will use {@link #getDefault} which returns a {@code TimeZone} based on
 * the time zone where the program is running.
 *
 * <p>You can also get a specific {@code TimeZone} {@link #getTimeZone by id}.
 *
 * <p>It is highly unlikely you'll ever want to use anything but the factory methods yourself.
 * Let classes like {@link Calendar} and {@link SimpleDateFormat} do the date
 * computations for you.

it would be even better if we could say how many times the problem occurs, so 
i'd have known straight away that there were two instances of the same error. 
(originally, the first reference to SimpleDateFormat was also unqualified, and 
actually _was_ on line 25.)

Original issue reported on code.google.com by jessewil...@google.com on 2 Sep 2010 at 8:58