Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Javadoc documentation render in place. Can one see pretty-print documentation in IDE?

Is there a plugin to Eclipse (or Visual Studio) which renders javadoc (or doxygen) in place, i.e. there is a pretty print in code instead of displaying javadoc source as comment?

By default it is possible just to fold method body. It could be usefull to have a toggle: full source, source and rendered javadoc, pure rendered javadoc.

Said plugin could generate something looking like this:

like image 573
user2622016 Avatar asked Aug 07 '13 08:08

user2622016


People also ask

How do I display Javadoc?

View Javadocs in the editorHover the mouse over the necessary symbol in the editor. Place the caret at the symbol and press Ctrl+Q (View | Quick Documentation). Press Ctrl+Q again to open this documentation in the Documentation tool window.

What is Javadoc documentation?

Javadoc is a documentation tool which defines a standard format for such comments, and which can generate HTML files to view the documentation from a web broswer. (As an example, see Oracle's Javadoc documentation for the Java libraries at http://download.oracle.com/javase/6/docs/api/.)

Where do I put Javadoc files?

As specified in the Javadoc tool documentation, in the "Miscellaneous Unprocessed Files" section: To include unprocessed files, put them in a directory called doc-files which can be a subdirectory of any package directory that contains source files. You can have one such subdirectory for each package.

How do I read Javadoc in Eclipse?

To see the javadoc of a class having attached source in eclipse: select Window -> show view -> javadoc (or alt + shift + q, j). then in the javadoc view, right click -> open attached javadoc (or shift + F2), this will display the javadoc of the class in the internal browser of eclipse.


1 Answers

Yes there is. In eclipse, just open or select the javadoc view and go to your own method

like image 78
Salandur Avatar answered Sep 28 '22 07:09

Salandur