NetBeans Forums

 FAQFAQ   SearchSearch   MemberlistMemberlist   RegisterRegister   ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 
  

Editor cannot find javadoc for Maven dependencies

 
Post new topic   Reply to topic    NetBeans Forums -> NetBeans Users
View previous topic :: View next topic  
Author Message
Alan
Posted via mailing list.





PostPosted: Wed Nov 17, 2010 4:11 pm    Post subject: Editor cannot find javadoc for Maven dependencies Reply with quote

This is on NB 6.9.1.
Back to top
anebuzelsky



Joined: 04 Nov 2009
Posts: 12

PostPosted: Thu Nov 25, 2010 9:18 am    Post subject: Editor cannot find javadoc for Maven dependencies Reply with quote

Hi,

I tried by adding a random dependency to a testing Maven project. The
dep was rome:rome 1.0. Then I entered WireFeed class name to my class in
editor and I can successfully Show Javadoc on that item from editor.

What library do you have as the dep? If not a public one, can you try
what I mention above, see if it works for you and then compare contents
of the rome's javadoc and your javadoc?

Please, file a bug under Projects/Maven with your findings.

Thanks
~tonda


On 11/17/2010 05:03 PM, Alan wrote:
Quote:
This is on NB 6.9.1.

I started using Maven as the build tool instead of ANT for all the
obvious reasons. One thing that does not work is that I cannot invoke
the java documentation (right-click > show Javadoc) in the editor for
objects that are in the Libraries section of the project navigator. I
get the dreaded "Cannot Show Javadoc Here" message.

The documentation files are there -- I can right click on the library
in the project manager, then pick "View Javadoc" in the popup menu,
and the index for the library comes up. Then I have to search out and
navigate to the object I wanted. The URL it feeds my browser points
to a local file into the Maven repository ( .m2/* ).

This is quite a pain (whine).

Is there a way to get the javadoc in the index list or whatever needs
to happen to get the editor's context-sensitive help function to work?
I bet it would save me about 400 hours a week.

OO
Back to top
Alan
Posted via mailing list.





PostPosted: Thu Nov 25, 2010 5:14 pm    Post subject: Editor cannot find javadoc for Maven dependencies Reply with quote

On Thu, Nov 25, 2010 at 1:09 AM, Antonin Nebuzelsky <address-removed ([email]address-removed[/email])> wrote:
Quote:

What library do you have as the dep? If not a public one, can you try


I don't need to do anything exotic.
Back to top
mdeggers



Joined: 28 Jan 2009
Posts: 208

PostPosted: Sun Nov 28, 2010 8:25 am    Post subject: Editor cannot find javadoc for Maven dependencies Reply with quote

If the Maven artifact contains the javadoc, you should be able to
right-mouse click on the Libraries folder and select Download Javadoc.

If the artifact maintainers didn't attach javadoc to the item, then you'll
have to find it and install it locally.

To do that, I did the following:

Code:
1. used jar to create an archive of the javadocs
    a. did it at the root of the javadoc tree
    b. included the resources directory (if any)
2. Right-mouse clicked on the library, selected Add local javadoc
    a. browsed to the jar file I created above
    b. added it
3. Then copied the file to the right location with the right name


For example - freemarker javadocs . . .

Code:
1a. cd freemarker-2.3.16/docs/docs/api
1b. jar cf freemarker-2.3.16-javadoc.jar * freemarker/ resources/
2a. browsed to the jar file
2b. added it
3.  cp freemarker-2.3.16-javadoc.jar ~/.m2/repository/org/freemarker/2.3.16


Not very pretty, but then right-mouse clicking on the library and selecting
view javadocs works. I haven't tried it from within the editor.

I don't like installing artifacts directly into my local repository, but if it's
just javadoc, then it might not be too big of a problem.

. . . . just my two cents

/mde/
Back to top
Display posts from previous:   
Post new topic   Reply to topic    NetBeans Forums -> NetBeans Users All times are GMT
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You can attach files in this forum
You can download files in this forum


Powered by phpBB
By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo