Re: [m2e-users] Javadoc generation for Eclipse project

[Thorbjørn Ravn Andersen <thunderaxiom@xxxxxxxxxxx>]

I have seen functionality subtly break when sharing workspaces between different flavors of Eclipse, so I was wondering if this problem is reproducible in a freshly unpacked Eclipse with a new workspace (and not importing anything)?

 

If not, it may be caused by having Eclipse-files checked into the version control system or just by reusing workspaces across versions.

 

/Thorbjørn

 

From: m2e-users-bounces@xxxxxxxxxxx [mailto:m2e-users-bounces@xxxxxxxxxxx] On Behalf Of Asaf Mesika
Sent: 1. november 2013 09:39
To: Maven Integration for Eclipse users mailing list
Subject: Re: [m2e-users] Javadoc generation for Eclipse project

 

He's right. I still don't understand your use case.

On Tuesday, October 8, 2013, Matthew Piggott wrote:

You shouldn't need to generate or attach javadocs for sources in Eclipse, it should be handled automatically by JDT.  e.g. If you hover on a documented method name a tooltip should appear with the javadoc inside, alternatively you can click on the method name and open the Eclipse Javadoc view.

 

On 8 October 2013 08:54, Steve Cohen <scohen@xxxxxxxxxxxxxxx> wrote:

I think you've missed my point.

The javadocs I'm interested in viewing are not downloaded from anywhere.  I know how to view javadocs from the packages I'm es using in Eclipse. That's not an issue.  The issue is the javadocs being generated from the source we're writing as we're writing it.

It's true, of course, that this is merely a nice-to-have.  You don't really NEED javadocs when you have the source right in front of you. But sometimes it's easier to read a well formed javadoc than to stare at an html-based javadoc comment in source.  Or maybe you'd like to test how that mass of html and text would format once converted to html.

That was my use case, in case anyone else ever wants it.  For what it's worth, the solution again is:

1) accept the default location in the javadoc plugin (or another location if you'd rather
2) Set the project property for javadoc location to the directory chosen in step 1.
3) Now in the javadoc window a new context menu item will be present:
Open Attached Javadoc (Shift-F2)

This will show the javadoc for the item being edited in a browser window within Eclipse.

On 10/03/2013 04:20 PM, Igor Fedorenko wrote:

You should not need to do anything. m2e is expected to download and use
dependency javadoc automatically. If automatic download does not work
for whatever reason, there is right-click action to force download.

--
Regards,
Igor

On 2013-10-03 2:49 PM, Steve Cohen wrote:

On 10/03/2013 01:31 PM, Igor Fedorenko wrote:

This is a general Maven user quesrion and as such maven users mailing
list is probably a better place to ask. Before you do, however, you may
want to google maven-javadoc-plugin and see if this gives you the info
you need.

--
Regards,
Igor

On 2013-10-03 1:47 PM, Steve Cohen wrote:

We have a java client project built with maven and developed in
Eclipse.
  I would like to incorporate javadoc generation such that the javadocs
would display in Eclipse on the Javadoc view.

In other words, the javadocs are primarily of use to developers working
on this project and not anywhere else.

What is the easiest way to accomplish this?
_______________________________________________
m2e-users mailing list
m2e-users@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/m2e-users

_______________________________________________
m2e-users mailing list
m2e-users@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/m2e-users

Yeah, I've looked there, but my question was aimed at how to configure
it (the plugin) so the Eclipse Javadoc window showed it.

Steve
_______________________________________________
m2e-users mailing list
m2e-users@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/m2e-users

_______________________________________________
m2e-users mailing list
m2e-users@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/m2e-users

_______________________________________________
m2e-users mailing list
m2e-users@xxxxxxxxxxx
https://dev.ecl