Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
What tools/websites do you use to read JavaDocs?
I currently use Firefox with 20+ tabs open when working on a J2EE project to have all the documentation available which is not very usable, is eating too much memory and is not searchable.
What I would expect from such a tool/website:
Aggregate JavaDocs from different locations
Direct access to types like Ctrl+T in Eclipse or similar
Fulltext search
Cross referencing between all the Java libraries I've chosen
For a tool: offline support
Speed
not mandatory:
possibility to annotate things
support for different versions of a library (+ diffing ?)
IDE integration
Edit:
Thanks for your answers. I knew most of the sites but gave them another try. Here is my judgement:
built-in Eclipse/IDE features
tightly integrated
offline/online support
javadoconline.com (no longer maintained)
works
clean looks
finds matches in more than one version of the api and allows easy switching
simple but working
fast
jdocs (offline)
seems very sophisticated
sometimes slow
some recent versions of libraries seem to be missing (Seam 2.0.0, Hibernate Validators) but it looks like you can add them yourself
IDE integration (not tested)
wiki style comments to each item
docjar.com
works
fast
cluttered UI
javadoc_isearch
greasemonkey script for firefox which makes navigating javadocs easier
works smooth and perfectly
JavaDoc jar can be unzipped directly. In theory any released javadocs can be downloaded and viewed offline.
download directly from maven repository. For example: http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar
Now you get objectify-5.0.3-javadoc.jar, rename the file to objectify-5.0.3-javadoc.zip
use your favourite unzip tool to extract it, now you have a folder objectify-5.0.3-javadoc
double click index.html will open the index page on your default browser.
If you use Eclipse, it offers support for Javadocs. For example, hovering your mouse over a method call will display a tooltip showing you the Javadoc for that method. Documentation for the core Java classes are supported out of the box. However, if your project uses any additional libraries (JAR files), some configuration is required in order to plug their Javadocs into Eclipse.
Go to the "Java Build Path" section of your project properties.
Go to the "Libraries" tab and click the "plus" icon next to the JAR file.
Click "Javadoc location", then the "Edit..." button.
This will let you specify where the Javadocs for that JAR are located. It will even let you specify a website URL, so you don't have to download the Javadocs yourself!
You can find Stanford University's JavaDoc here.
I wrote my own tool for this. Acording to my colleagues it is best they seen.
It indexes by lucene once, and run you small server on background, so yo browse javadocs (pydocs, perldocs..) like in browser. It allows also separate libraries per language so searchses like "biginteger" or simialr dont go wrong.
https://github.com/judovana/JavadocOfflineSearch/releases
I use http://www.teria.com/~koseki/tools/gm/javadoc_isearch/ for FF. Lets me easily browse other libraries as well.
Eclipse integrates well with Javadoc and has an HTML-like viewer for it. You can attach source and javadoc to binaries that will show up when you select a class.
Something like this may be useful?
http://www.docjar.com/
Personally, I've never had a problem with the built-in javadoc browsing tools offered by my IDE.
Currently, I use IntelliJ Idea -- Ctl-Q brings up the javadoc for the method under the cursor, with the hyperlinks to other parts of the documentation functional.
I would imagine NetBeans and Eclipse offer similar functionality.
Hm... How about:
http://edu.netbeans.org/quicktour/javadoc.html - NetBeans supports the Javadoc standard for Java documentation - both viewing it and generating it.
http://globaldocs.zeevbelkin.com/ - This application allows to conveniently browse, over the Internet and local filesystem, multiple javadoc sets, using a single packages/classes hierarchy tree and a searchable index. The viewer supports local and remote docsets (the local docsets, packed to JAR/ZIP-files also are supported).
I prefer NetBeans as it get JavaDoc from Maven ~/.m2 directory automatically...
This plug in for Firefox and Chrome is useful for quickly finding package and class names, though it's not a full text search: https://code.google.com/p/javadoc-search-frame/
Eclipse is a best way to see the javadocs. Hovering the mouse on method or any declaration you will get automatically generated javadocs by eclipse.
Doxygen (http://www.doxygen.nl/) might fit the bill.
EDIT: I may have misread your question, doxygen is a tool to generate documentation and models based off your code and javadoc.
Related
I am using Eclipse to build a small Java project. I am wanting to include in my Java documentation the project overview, this is so that the index page contains information about the project title, its purpose etc.
I know that I can include an ovwerview.html page in my project and have done.
As per the Java Documentation, I have also read that I need to use an -overview option to activate the merging of my overview.html into the index page for the Java Doc:
https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDGDJAH
However, I do not know how to use this. On the third page of Eclipse's JavaDoc wizard is the option to include VM options and so I entred -overview "src/overview.html", but this had no effect. I tried just -overview "overview.html" but this had no effect either.
How do I do this?
In Eclipse JavaDoc wizard, you should have an "overview" field on the top of the third page.
If so, you should be able to manually select it and then generate the javadoc.
If not, consider updating your JavaDoc plugin for Eclipse, if possible.
I have recently started learning to develop minecraft plugins and heard a good way to learn is to decompile other plugins and then learn what the code inside them does but i looked it up and could not find a way to do that.
If you would like to decompile plugins, I would recommend using a program called Luyten. You can open up jar files and see whats inside and see the code. Keep in mind, some plugins may be obfuscated and decompiling some plugins may be against the developer's TOS. If you are in the clear, you can open up a jar file in Luyten by dragging the file onto the window and you can have a look at the code there. But if you would like to edit the code in something like eclipse, you can click the 'File' tab up the top right and click 'Save All'. Then extract all the files inside the zip file and then open up the project in eclipse.
Like #exro mentioned before, you should use Luyten to decompile the code first and be aware of the developer's terms of service and the copyright licensing of the code as sometimes attempts to re-create/decompile the code will be considered a violation of their copyright and could get you into legal issues.
#exro has done quite a good job explaining how to do it on Luyten, though I'd personally like to recommend that you check out github.com and have a look at some of these projects.
https://github.com/ElevatedDev/Frequency
Frequency is a Spigot open-sourced Anti-Cheat made by a few developers and the licensing should enable you to re-create the code in Eclipse without any legal difficulties though this should not be considered legal advice (Please also note that Frequency is created in IntelliJ and Maven so I would recommend that you either learn how to use those tools or just be aware of what they are).
https://www.youtube.com/watch?v=wysn_pFhcmE&list=PLdnyVeMcpY79UFZFfqwaXF2GUGc0v3YyG
This is a beginner-friendly Bukkit/Java coding course which will get you over the first few projects you'll do.
I'm wanting to style Swing components with CSS and saw this as my best bet. But I'm having a bit of a problem just finding out if I can use it with Eclipse?
Is it also practical for a medium sized project, or should I be looking for another way to style components?
Here is the Document for your answer
https://docs.google.com/document/d/19bYF0z5sNiwT-zL5VAZBY1CM0MgHA6pqzZ8dP22llvc/edit?usp=sharing
I am not an expert on a subject of Swing and especially JAXX, but I know a thing or two about Eclipse. If this question is still relevant, you can take my answer as a basis to do some more research.
I searched an Eclipse Marketplace and googled a bit but found nothing about JAXX Eclipse support or plugins. If you know french you can check project's documentation. If there is nothing about tool support in the documentation, I suggest you ask the creators directly.
Eclipse gives you some tools you can use to work with file types JAXX uses. From what I have read here, *.jaxx files are just XML files and stylesheets are just a CSS. I suggest you install XML and CSS support through Eclipse Web Tools Platform and associate *.jaxx files with XML editor either when you first open one of the files with such extension or through File Associations Preferences. In order to compile *.jaxx files you can configure Eclipse Project Builder or use an External Tools launcher.
By the way, have you considered using JavaFX?
#duemir
I have mentioned same thing in my Answer Document.
Please check the Above answer by Me (Jugal Thakkar)
OR
Click on this Link
Go to your Link and Check the Resource in that page and try to go Official Website of JAXX.
You are not able to Go on Official Project Page (www.jaxxframework.org/).
I have mentioned all things in My Document so please first go through that.
I can conclude that on This Question.
1) This Project is not Officially Working. because you can't open official Project Website.
so you are not able to access docs and other stuff.
I looked through this list of “Hidden” features/tricks for Eclipse?", but it doesn't have anything for web-developement (jsp). A very useful list of tricks for a general eclipse user!
I work with jsp pages in Eclipse Ganymede, and I would like to find out a list of shortcuts commonly used to facilitate development. I always seem to struggle with the following, among other issues:
always traverse a directory tree to find a file (no Ctrl-shift-t just like java classes)
search is always ends up with either ctrl-f or searching the entire project
I would appreciate if you guys list tricks for eclipse, specifically for web-development (jsp/tomcat)
I am a noob, so don't hesitate to list anything even if you think it is TOO NOOB!!!
Thanks
my favorite:
ctrl + shift + r will open a resource dialog like the type dialog
Refer 30 Useful Eclipse Keyboard Shortcuts for Java Programmers for more.
First of all, be certain you use the Java EE version of Eclipse.
Edit:
Use Ctrl-Shift-R to locate a given resource (also known as "file").
You can use F3 on java identifiers in <%...%> to go to their definition.
The best tip I can give you is to learn JSF or similar so your JSP files only contain tags, and not java snippets.
I use the MyEclipse plugin. I have been very happy with it and it has a lot of jsp support.
MyEclipse
Get the Web Tools Platform plugin. I think it's included by default in the Jave EE edition of Eclipse, but you can also install it separately. To see if it's installed in your Eclipse, open the Help|About screen and look for a "WTP" icon.
It doesn't provide any web-specific shortcuts, but it will give you syntax highlighting and some auto-completion for HTML and CSS files, and for JSP files, enable many of the navigation features that you're used to from Java editing. (Such as Ctrl+Space to import a class and F3 to see its definition.)
Regardless of whether you have WTP installed or not:
Use Ctrl+Shift+R to open files; this works much like Ctrl+Shift+T for opening classes.
Use Ctrl+H to search the whole of your project, or parts of it. If you pick the "File search" tab, you can specify file patterns (such as *.jsp) to search in. If you click on a folder in the Package Explorer, you can select "Selected resources" from the "Scope" box to search only in that folder (and its sub-folders).
I am writing some applications that require to have a Help Contents system tied to it. I came across JavaHelp which seems perfect for what I need.
The issue I am having is that when you download JavaHelp, it comes with its own bin folder which looks like you are suppose to use separately. However, I am pretty sure if I just copy some of the JAR files I should be able to just place them in the hierarchy in my Eclipse and use it in the project.
What JAR(s) would I need to copy so I can use JavaHelp in my application?
Update
I got JavaHelp working rather easily. I had issues with the built in Eclipse Help though. But I appreciate both of your answers!
If anyone is interested in knowing how to add JavaHelp to your project (doesn't have to be Eclipse specific), I will be more than happy to provide the answer here.
The JavaHelp README details the redistributable jar files that are supplied in the download. Select the jar that suits your needs and add it to your Eclipse project.
While JavaHelp is a good api, Eclipse has its own api for help, and (IMO) it's a much better option for SWT based applications. See this developerworks article on developing help using the Eclipse help system.
If you're actually creating a swing application, and want to package java help with it, you'll need to create the help documents (help topics, helpset file, map file, TOC, index, full-text search db) and then package those files into a jar for distribution with your application. See the JavaHelp Users Guide for details.
For running the help viewer from the Eclipse IDE (and from your application at runtime), all you need is the jar file jhall.jar from the JavaHelp distribution.