[JAVA-3059] Generate Javadoc in HTML5 Created: 21/Oct/18  Updated: 28/Oct/23  Resolved: 25/Oct/18

Status: Closed
Project: Java Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.9.0

Type: Improvement Priority: Minor - P4
Reporter: Farès Hassak Assignee: Jeffrey Yemin
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

javadoc: warning - You have specified the HTML version as HTML 4.01 by using the -html4 option.
 The default is currently HTML5 and the support for HTML 4.01 will be removed in a future release. To suppress this warning, please ensure that any HTML constructs in your comments are valid in HTML5, and remove the -html4 option.

The <tt> tag is not supported in HTML5. Use the <code> element in javadoc comments



 Comments   
Comment by Githook User [ 25/Oct/18 ]

Author:

{'name': 'Jeff Yemin', 'email': 'jeff.yemin@10gen.com', 'username': 'jyemin'}

Message: Generate Javadoc in HTML 5 format

Replace all <tt> tags with either @code or <code> so that the Javadoc
parses as HTML 5.

JAVA-3059
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/09c21f3627fef24cfed87076e02202955a933180

Comment by Jeffrey Yemin [ 22/Oct/18 ]

https://github.com/jyemin/mongo-java-driver/pull/188

Comment by Jeffrey Yemin [ 22/Oct/18 ]

Never mind. I see it when building with Java 11.

Comment by Jeffrey Yemin [ 22/Oct/18 ]

The <tt> tag is not supported in HTML5. Use the <code> element in javadoc comments

Where are you seeing this warning about the <tt> tag? I'm not seeing it myself even when I remove the html4 option in build.gradle.

Generated at Thu Feb 08 08:58:41 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.