Modify

#16048 closed enhancement (fixed)

Generate HTML5 javadoc

Reported by: Don-vip Owned by: team
Priority: normal Milestone: 18.03
Component: Core Version:
Keywords: html5 java9 java10 Cc:

Description

When running javadoc ant target with Java 9/10/11 we should generate HTML5 javadoc.

Currently, specifying -html5 option to javadoc raises 71 errors we need to fix first:

  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\gui\jmapviewer\Coordinate.java:14: error: tag not supported in the generated HTML version: tt
  [javadoc]  * via <tt>lat</tt> and <tt>lon</tt>.
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\gui\jmapviewer\Coordinate.java:14: error: tag not supported in the generated HTML version: tt
  [javadoc]  * via <tt>lat</tt> and <tt>lon</tt>.
  [javadoc]                         ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\UserIdentityManager.java:40: error: tag not supported in the generated HTML version: tt
  [javadoc]  * <tt>GET /api/0.6/user/details</tt> request, submitted with the user name and password
  [javadoc]    ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\dialogs\ToggleDialog.java:280: error: tag not supported in the generated HTML version: tt
  [javadoc]      * Emits {@link PropertyChangeEvent}s for the property <tt>selected</tt>:
  [javadoc]                                                            ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\help\HelpContentReader.java:16: error: tag not supported in the generated HTML version: tt
  [javadoc]  * The help content has to be <strong>filtered</strong> because only the main content <tt>&lt;div&gt;</tt>
  [javadoc]                                                                                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\mappaint\MapPaintStyles.java:87: error: tag not supported in the generated HTML version: tt
  [javadoc]      * results in a tag reference for the tag <tt>a_tag_name</tt> in the
  [javadoc]                                               ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\mappaint\styleelement\LabelCompositionStrategy.java:32: error: tag not supported in the generated HTML version: tt
  [javadoc]  *   see the preference options <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>.</li>
  [javadoc]                                 ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\mappaint\styleelement\LabelCompositionStrategy.java:32: error: tag not supported in the generated HTML version: tt
  [javadoc]  *   see the preference options <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>.</li>
  [javadoc]                                                                 ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\mappaint\styleelement\LabelCompositionStrategy.java:138: error: tag not supported in the generated HTML version: tt
  [javadoc]      * see the preference options <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>
  [javadoc]                                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\mappaint\styleelement\LabelCompositionStrategy.java:138: error: tag not supported in the generated HTML version: tt
  [javadoc]      * see the preference options <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>
  [javadoc]                                                                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\tagging\TagTable.java:568: error: tag not supported in the generated HTML version: tt
  [javadoc]      * to handle the client property <tt>terminateEditOnFocusLost</tt>.
  [javadoc]                                      ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\actions\OpenLocationAction.java:299: error: tag not supported in the generated HTML version: tt
  [javadoc]      * @return <tt>true</tt> (as specified by {@link Collection#add})
  [javadoc]                ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\imagery\OffsetBookmark.java:314: error: tag not supported in the generated HTML version: tt
  [javadoc]      *         (<tt>index &lt; 0 || index &gt;= size()</tt>)
  [javadoc]                 ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\IPrimitive.java:221: error: tag not supported in the generated HTML version: tt
  [javadoc]      * of the tag <tt>name</tt> or null, if this tag is not present.
  [javadoc]                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\DefaultNameFormatter.java:98: error: tag not supported in the generated HTML version: tt
  [javadoc]      *   <li>by the tag names in the preference <tt>relation.nameOrder</tt></li>
  [javadoc]                                                 ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\DefaultNameFormatter.java:115: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>osm-primitives.showid</tt> is set. Shows unique id if osm-primitives.showid.new-primitives is set
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\DefaultNameFormatter.java:513: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>osm-primitives.showid</tt> is set.
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\Way.java:529: error: tag not supported in the generated HTML version: tt
  [javadoc]      * The result equals <tt>{@link #getNode getNode}({@link #getNodesCount getNodesCount} - 1)</tt>.
  [javadoc]                          ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\history\HistoryOsmPrimitive.java:303: error: tag not supported in the generated HTML version: tt
  [javadoc]      * of the tag <tt>name</tt> or null, if this tag is not present.
  [javadoc]                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\visitor\paint\relations\Multipolygon.java:42: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <em>outer</em> polygon. Default is <tt>outer</tt>.
  [javadoc]                                           ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\osm\visitor\paint\relations\Multipolygon.java:52: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <em>inner</em> polygon. Default is <tt>inner</tt>.
  [javadoc]                                           ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\preferences\AbstractProperty.java:142: error: tag not supported in the generated HTML version: tt
  [javadoc]          * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]            ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\preferences\AbstractProperty.java:142: error: tag not supported in the generated HTML version: tt
  [javadoc]          * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                                                                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\projection\ProjectionConfigurationException.java:18: error: tag not supported in the generated HTML version: tt
  [javadoc]      *         {@link #getCause()} method).  (A <tt>null</tt> value is
  [javadoc]                                                 ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\projection\ProjectionConfigurationException.java:37: error: tag not supported in the generated HTML version: tt
  [javadoc]      *         {@link #getCause()} method).  (A <tt>null</tt> value is
  [javadoc]                                                 ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\tests\RelationChecker.java:180: error: tag not supported in the generated HTML version: tt
  [javadoc]      * @return <tt>true</tt> if member passed any of definition within preset
  [javadoc]                ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\help\HelpContentReaderException.java:25: error: tag not supported in the generated HTML version: tt
  [javadoc]      *        (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.)
  [javadoc]                  ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\io\DownloadFileTask.java:62: error: tag not supported in the generated HTML version: tt
  [javadoc]          *         {@link #getCause()} method).  (A <tt>null</tt> value is
  [javadoc]                                                     ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\mappaint\styleelement\LabelCompositionStrategy.java:232: error: tag not supported in the generated HTML version: tt
  [javadoc]          * <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>.
  [javadoc]            ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\mappaint\styleelement\LabelCompositionStrategy.java:232: error: tag not supported in the generated HTML version: tt
  [javadoc]          * <tt>mappaint.nameOrder</tt> and <tt>mappaint.nameComplementOrder</tt>.
  [javadoc]                                            ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\gui\util\GuiHelper.java:248: error: tag not supported in the generated HTML version: tt
  [javadoc]      * @param <V> the result type of method <tt>call</tt>
  [javadoc]                                             ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\ChangesetQuery.java:352: error: tag not supported in the generated HTML version: tt
  [javadoc]          *         (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.)
  [javadoc]                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\ChangesetQuery.java:360: error: tag not supported in the generated HTML version: tt
  [javadoc]          * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]            ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\ChangesetQuery.java:360: error: tag not supported in the generated HTML version: tt
  [javadoc]          * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                                                                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\ChangesetQuery.java:363: error: tag not supported in the generated HTML version: tt
  [javadoc]          *         (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.)
  [javadoc]                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\DefaultProxySelector.java:53: error: tag not supported in the generated HTML version: tt
  [javadoc]      * from the system settings, if the system property <tt>java.net.useSystemProxies</tt>
  [javadoc]                                                         ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\DefaultProxySelector.java:69: error: tag not supported in the generated HTML version: tt
  [javadoc]      * from the system settings, if the system property <tt>java.net.useSystemProxies</tt>
  [javadoc]                                                         ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\DefaultProxySelector.java:73: error: tag not supported in the generated HTML version: tt
  [javadoc]      * @return true, if <tt>java.net.useSystemProxies</tt> was set to true at class initialization time
  [javadoc]                         ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmApiException.java:73: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt>
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmApiException.java:74: error: tag not supported in the generated HTML version: tt
  [javadoc]      * (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                  ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmApiException.java:77: error: tag not supported in the generated HTML version: tt
  [javadoc]      *              A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.
  [javadoc]                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmApiInitializationException.java:22: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt>
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmApiInitializationException.java:23: error: tag not supported in the generated HTML version: tt
  [javadoc]      * (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                  ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmApiInitializationException.java:26: error: tag not supported in the generated HTML version: tt
  [javadoc]      *              A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.
  [javadoc]                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmServerBackreferenceReader.java:172: error: tag not supported in the generated HTML version: tt
  [javadoc]      * incomplete primitives are read from the server with an individual <tt>/api/0.6/[way,relation]/#id/full</tt>
  [javadoc]                                                                          ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmTransferCanceledException.java:21: error: tag not supported in the generated HTML version: tt
  [javadoc]      *              A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.
  [javadoc]                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmTransferException.java:30: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt>
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmTransferException.java:31: error: tag not supported in the generated HTML version: tt
  [javadoc]      * (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                  ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\io\OsmTransferException.java:34: error: tag not supported in the generated HTML version: tt
  [javadoc]      *              A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.
  [javadoc]                       ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\plugins\PluginDownloadException.java:30: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\plugins\PluginDownloadException.java:30: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                                                                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\plugins\PluginException.java:41: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\plugins\PluginException.java:41: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                                                                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\plugins\PluginListParseException.java:21: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\plugins\PluginListParseException.java:21: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                                                                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\I18n.java:573: error: tag not supported in the generated HTML version: tt
  [javadoc]      * isn't found the default local is set to <tt>en</tt> (english).
  [javadoc]                                                ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\ImageProvider.java:362: error: tag not supported in the generated HTML version: tt
  [javadoc]      * If name starts with <tt>http://</tt> Id is not used for the cache.
  [javadoc]                            ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\JosmRuntimeException.java:22: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\JosmRuntimeException.java:22: error: tag not supported in the generated HTML version: tt
  [javadoc]      * <tt>(cause==null ? null : cause.toString())</tt> (which typically contains the class and detail message of <tt>cause</tt>).
  [javadoc]                                                                                                                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\UncheckedParseException.java:32: error: tag not supported in the generated HTML version: tt
  [javadoc]      *                (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.)
  [javadoc]                          ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\UncheckedParseException.java:42: error: tag not supported in the generated HTML version: tt
  [javadoc]      *              (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.)
  [javadoc]                        ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\UserCancelException.java:23: error: tag not supported in the generated HTML version: tt
  [javadoc]      *         (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.)
  [javadoc]                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\tools\UserCancelException.java:42: error: tag not supported in the generated HTML version: tt
  [javadoc]      *         (A <tt>null</tt> value is permitted, and indicates that the cause is nonexistent or unknown.)
  [javadoc]                   ^
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name
  [javadoc] C:\SVN\josm\core\src\org\openstreetmap\josm\data\validation\routines\package.html:295: error: attribute not supported in HTML5: name

Attachments (0)

Change History (3)

comment:1 Changed 18 months ago by Don-vip

In 13491/josm:

see #11924, see #15560, see #16048 - explicitly generate HTML4 javadoc until all errors/warnings are fixed

comment:2 Changed 18 months ago by Don-vip

In 13493/josm:

see #11924, see #15560, see #16048 - tt HTML tag is deprecated in HTML5: use code instead

comment:3 Changed 18 months ago by Don-vip

Resolution: fixed
Status: newclosed

In 13494/josm:

see #11924, see #15560, fix #16048: Generate HTML5 javadoc with Java 9/10/11

  • name HTML attribute is deprecated in HTML5: use id instead

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain team.
as The resolution will be set.
The resolution will be deleted.

Add Comment


E-mail address and name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.