JDK-8092662 : Identify and fix all broken JavaDoc links
  • Type: Bug
  • Component: javafx
  • Sub-Component: other
  • Affected Version: fx2.0
  • Priority: P3
  • Status: Closed
  • Resolution: Duplicate
  • Submitted: 2011-06-28
  • Updated: 2015-06-12
  • Resolved: 2014-12-17
Related Reports
Blocks :  
JDK-8114290 - Wrong links in Javadoc of builders
Blocks :  
JDK-8114778 - Javadoc problems in controls
Duplicate :  
JDK-8090255 - Fix doclint errors and warnings in JavaFX API docs
Relates :  
JDK-8114718 - javafx-doclet: error in http link for property
Relates :  
JDK-8114278 - javafx-doclet: error in http link for field
Relates :  
JDK-8114766 - TableColumn javadoc problems
Relates :  
JDK-8114765 - TableView JavaDoc has many broken see also links
Description
I keep finding broken javadoc links such as SeeAlso. I believe this is happening due to API changes. It makes sense to run some JavaDoc verification tool rather then find them on case-by-case basis.
Comments
We will track javadoc warnings with RT-38331, so closing this as a duplicate.
17-12-2014
This is an old issue, but we still have some warnings in our docs, so would be good to fix this at some point.
26-03-2014
Not sure which Component this should be assigned to, but it is definitely unrelated to Core Libraries
08-11-2011
Moving to Presidio Updates since Presidio is done.
15-09-2011
This bug depends on a deferred one, I suggest to defer it as well.
14-09-2011
Reassigning to Docs, as that is the component type of the only remaining linked issue.
13-09-2011
All controls issues have been resolved. This should no longer be a 'control' component - please reassign as appropriate.
13-09-2011
Changing component to Control since it has the only remaining Presidio sub-issue.
05-09-2011
Cell #setItem(T) link is broken
12-08-2011
Mikhail, do you have it filed?
12-08-2011
yes it does. These are the broken anchor links i mentioned. There > 2000 of such broken links now. There is a bug in javadoc generation that Victor Shubov will file as a separate issue
04-07-2011
Mikhail, does it check for unresolved links like "#goto(something)"? These are not translated into URLs by JavaDoc so may be overlooked by your tool. See RT-14609 for examples.
04-07-2011
I have executed linklint against latest presidio build. It found several broken links plus a lot of broken links to non-existent anchors. The broken links report is below, the anchor links need some investigation will be filed as a separate issue: root: /home/mikhail/Downloads/api/api date: Mon, 04 Jul 2011 13:27:34 (local) Linklint version: 2.3.5 #------------------------------------------------------------ # ERROR 3 missing html files (cross referenced) #------------------------------------------------------------ /javafx/scene/control/javafx.scene/doc-files/cssref.html used in 1 file: /javafx/scene/control/package-summary.html /javafx/scene/javafx.scene/doc-files/cssref.html used in 1 file: /javafx/scene/package-summary.html /javafx/scene/javafx.scene/javafx.scene.Node.html used in 1 file: /javafx/scene/effect/Effect.html #------------------------------------------------------------ # ERROR 1 missing image file (cross referenced) #------------------------------------------------------------ /javafx/scene/javafx.scene/doc-files/Scene1.png used in 1 file: /javafx/scene/package-summary.html #------------------------------------------------------------ # ERROR 1 missing other file (cross referenced) #------------------------------------------------------------ /javafx/scene/media/doc-files/HelloMedia.java used in 1 file: /javafx/scene/media/package-summary.html root: /home/mikhail/Downloads/api/api date: Mon, 04 Jul 2011 13:27:34 (local) Linklint version: 2.3.5 #------------------------------------------------------------ # warn 7 files with warnings #------------------------------------------------------------ /javafx/scene/chart/XYChart.Series.html had 1 warning unquoted "<" in /javafx/scene/chart/XYChart.html had 1 warning unquoted "<" in /javafx/scene/control/Cell.html had 1 warning unquoted "<" in < /javafx/scene/control/ListView.html had 1 warning unquoted "<" in /javafx/scene/control/TableColumn.html had 1 warning unquoted "<" in /javafx/scene/control/TableView.html had 1 warning unquoted "<" in /javafx/scene/control/TreeView.html had 2 warnings unquoted "<" in <"="" in="" <="" pre=""> <>
04-07-2011