Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Missing iFrame view for Javadocs JDK 11+

Tags:

java

javadoc

I've been using the JavaDocs for JDK 11

But I've noticed that the iFrames view appears no longer to be available. I've looked around, but can't see any details on why this has been done, and what the alternatives are if any? Can anyone provide more detail?

View for JDK 10

JavaDocs for JDK 10

View for JDK 11

JavaDocs for JDK 11

like image 538
muttonUp Avatar asked Aug 23 '18 18:08

muttonUp


People also ask

Is deprecated in Java 11?

Following deprecated Java EE and CORBA are removed from Java 11 release.

How do I view Javadoc in HTML?

To view an HTML documentation file, open your web browser and specify the file name of the javadoc you want to view, taken from the classdocs directory. Any of the following files are good for getting started: classdocs/AllNames. html.

How do I enable Javadoc?

From the main menu, select Tools | Generate JavaDoc. In the dialog that opens, select a scope — a set of files or directories for which you want to generate the reference, and set the output directory where the generated documentation will be placed.

Is Javadoc part of JDK?

Javadoc 5 is included in J2SE Platform Development Kit Standard Edition 5 (JDK 5) Javadoc 1.4 is included in Java 2 SDK, Standard Edition v 1.4. Javadoc 1.3 is included in Java 2 SDK, Standard Edition v 1.3. Javadoc 1.2 is included in Java 2 SDK, Standard Edition v 1.2.


2 Answers

In case anyone else has the same query, Frames are no longer generated by Default.

This is covered in JDK-8202961

In times past, to allow for navigation within API documentation, the standard doclet presented indexes in frames on the left side of the window to allow classes, packages and (more recently) modules to be selected for display in the main body of the window.

More recently, the doclet now supports a "search" feature, which provides a more versatile way of finding items to view. Separately, the doclet is moving towards using HTML 5 (only), and the basic support for frames in HTML 5 is less than it was in HTML 4.

and JDK-8187794 among others

Update the javadoc/doclet to generate no frames as a default. A warning should be generated if "--frames" option is specified to generate frames. The support for frames will be removed from a future release.

It seems that if you really wanted to use frames you could generate your own from the JDK src and experience the warning, but this will be removed completely at some point.

In summary, get used to the Search function, framed javadocs are on their way out!

like image 161
muttonUp Avatar answered Sep 20 '22 17:09

muttonUp


I created JANITOR – Java API Navigation Is The Only Rescue which:

Inserts a navigation tree for modules, packages and types (interfaces, classes, enums, exceptions, errors, annotations) into the Javadoc pages of Java 11+.

JANITOR – Java API Navigation Is The Only Rescue

like image 36
Gerold Broser Avatar answered Sep 19 '22 17:09

Gerold Broser