Menu
I'm trying to include images in my JavaDoc. I follow documentation and store an image in the doc-files in the package directory. My javadoc looks like:
/**
* This is class desctiprion. Image:
* <p><img src="doc-files/image.png"/></p>
*/
When I generate Javadoc the image is shown but when I try to review Javadoc in the Idea it shows just image stub. How can I manage this?
700
Add a Javadoc using automatic commentsType /** before a declaration and press Enter . The IDE auto-completes the doc comment for you. For information on how to disable this feature, refer to Disable automatic comments.
put the cursor on the method name you want to add javadoc ,and then press alt + enter, there will be an add javadoc option in the popup. If the method already has a javadoc,then there will be no add javadoc option.
Writing Javadoc Comments In general, Javadoc comments are any multi-line comments (" /** ... */ ") that are placed before class, field, or method declarations. They must begin with a slash and two stars, and they can include special tags to describe characteristics like method parameters or return values.
It looks like the built-in JavaDoc viewer doesn't do what you want.
There are a few other possibilities, though:
I haven't tried it, but there's a JavaDoc viewer plugin at http://plugins.jetbrains.com/plugin/612 - give it a try, and see if it meets your needs.
Perhaps you could write a plugin using jetbrains' api?
Put in a feature request.
115
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
