• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Ron McLeod
  • Paul Clapham
  • Jeanne Boyarsky
  • Liutauras Vilda
Sheriffs:
  • Rob Spoor
  • Bear Bibeault
  • Tim Cooke
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Piet Souris
Bartenders:
  • Frits Walraven
  • Himai Minh

Enabling frame view for Java 11 API documentation

 
Greenhorn
Posts: 1
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi :-)

I prefer to read the API documentation within frames, showing modules, a class list as well as class details. I know that others prefer different formats.

Java 10 API documentation has a "Frames | No Frames | All classes" navigation bar at the top level, which seems to address all personal preferences. (I had thought this to be built in to the standard doclet but am now questioning my sanity)
https://docs.oracle.com/javase/10/docs/api/overview-summary.html

Java 11 and later API documentation does not seem to provide this:
https://docs.oracle.com/en/java/javase/11/docs/api/index.html

Accessing the documentation seems to force one to select module, then package, then class. I find this very difficult to internalise the underlying structure of API organisation.

I'm guessing I'm missing something 'obvious' because I've searched the Internet as well as forums here for some insight and guidance without success. I can't believe I'm the only person with this problem.

Thanks for reading and I hope that you can help :-)
 
Saloon Keeper
Posts: 8220
71
Eclipse IDE Firefox Browser MySQL Database VI Editor Java Windows
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Yes, frames is no more. There is a new search in the upper right corner that is  very powerful and may give you what you need.
 
Marshal
Posts: 72905
330
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
...and welcome to the Ranch

I miss the old frames view, but even I learnt to use the search box.
 
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
My contempt for the people who removed the organizing frames from the api documentation has no bounds.    The idea that a "good search" function can replace that is so deeply flawed I don't even know where to start.   By all means, have a good search function, but don't obtain it at the sacrifice of the overall usability of the documentation.    I used to laugh at what the MS world called .net "documentation" for its complete lack of transparency and organization.   I'm not laughing anymore.  
 
Campbell Ritchie
Marshal
Posts: 72905
330
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Welcome to the Ranch
 
Campbell Ritchie
Marshal
Posts: 72905
330
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Agree that the old frames view was so useful.
 
Ross Cohen
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Campbell Ritchie wrote:Welcome to the Ranch



Thanks.    I think I had an account here like 15 years ago, but I haven't been in a while.

I don't know why this frames thing has me so upset, but it does.   I guess it suggests that the people at the top are visionless, clueless, backwards, and incredibly well insulated from reality.    Since about 6 years ago have been increasingly suspected this to be the case, but actual confirmation is upsetting.      I suppose their next step will be to get rid of the '*' operator -- because, well,  you know you can accomplish the same thing with '+' and a loop.  

I guess its time to finally make my own language ...

 
Saloon Keeper
Posts: 12988
281
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Ross Cohen wrote:I used to laugh at what the MS world called .net "documentation" for its complete lack of transparency and organization.


.NET documentation is really super weird. On the one hand is their API documentation, which is still really bad in many cases. On the other hand are their developer manuals for different technologies and frameworks, which are really well written. Examples of great documentation come from Entity Framework Core and ASP.NET Core.

The one thing that still really screams at me how terrible Microsoft is at writing good documentation is the JavaScript Office Add-in API. Good luck if you need to find anything from there.
 
Marshal
Posts: 26591
81
Eclipse IDE Firefox Browser MySQL Database
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Campbell Ritchie wrote:Agree that the old frames view was so useful.



Whenever I followed a link to an old version of the API, I would immediately click on the "NO FRAMES" link. I found the "FRAMES" version very annoying. Don't know why though. Takes all kinds to make a world.
 
Greenhorn
Posts: 1
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I was very used to navigate with frames
 
Campbell Ritchie
Marshal
Posts: 72905
330
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
So did I, JL, but they have withdrawn it.
And welcome to the Ranch
 
Saloon Keeper
Posts: 4497
166
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Still on java 10, with the frames, but I always use the search bar, way handier than scrolling for some class
 
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
reply
    Bookmark Topic Watch Topic
  • New Topic