Results 1 to 12 of 12
  1. #1
    Eranga's Avatar
    Eranga is offline Moderator
    Join Date
    Jul 2007
    Location
    Colombo, Sri Lanka
    Posts
    11,372
    Blog Entries
    1
    Rep Power
    19

  2. #2
    CaptainMorgan's Avatar
    CaptainMorgan is offline Moderator
    Join Date
    Dec 2007
    Location
    NewEngland, US
    Posts
    835
    Rep Power
    8

    Default

    I assume you mean the API documentation... Once you've downloaded to your intended location, make a note of where you put it. In Netbeans, follow these steps:

    Tools -> Java Platforms.
    Click on the JavaDoc tab.
    Click Add/Zip folder... and navigate to your documentation download.
    Finally click Add/Zip folder and then hit Close.

    It should work after that... I put mine in /usr/lib/jvm/java-6-sun/, so from Netbeans I added both the directories /usr/lib/jvm/java-6-sun/docs and/or /usr/lib/jvm/java-6-sun/docs/api just to be safe. Only one is required though. If you use the top level docs, you will get the top level of the whole documentation(pretty obvious), but it includes a wealth of other stuff that is very interesting. Only doing the **/docs/api directory I believe is necessary to use the JavaDoc whilst developing in Netbeans. For example, Alt-F1 while the cursor is on the class in question will open the JavaDoc for that class in the default browser.

    Have fun! :)
    Vote for the new slogan to our beloved Java Forums! (closes on September 4, 2008)
    Want to voice your opinion on your IDE/Editor of choice? Vote now!
    Got a little Capt'n in you? (drink responsibly)

  3. #3
    Eranga's Avatar
    Eranga is offline Moderator
    Join Date
    Jul 2007
    Location
    Colombo, Sri Lanka
    Posts
    11,372
    Blog Entries
    1
    Rep Power
    19

    Default

    Thanks pal, I'll try it. At the time I have downloaded doc. I'm going to add it now, and I'll let you know something is wrong with me.

  4. #4
    Eranga's Avatar
    Eranga is offline Moderator
    Join Date
    Jul 2007
    Location
    Colombo, Sri Lanka
    Posts
    11,372
    Blog Entries
    1
    Rep Power
    19

    Default

    Hi Captain,

    As you said I've include the Java documentation in Netbeans. Then I try to search some results. Simply select a keyword and press Shift+F1 keys. It's open the Javadoc Index Search panel on the Netbeans.

    I can see my selected key word on the text field also. On the searching box, there is a message displaying, Please wait...

    I've wait for a long time, but the result is not displayed. Should I have to do anything more that what I have done up to now.

    I don't think my PC configuration is not enough for this. Any comments. :)

  5. #5
    Eranga's Avatar
    Eranga is offline Moderator
    Join Date
    Jul 2007
    Location
    Colombo, Sri Lanka
    Posts
    11,372
    Blog Entries
    1
    Rep Power
    19

    Default

    Ah, it's not working pal. Got a message after a long time that, No Documentation Found. I've attached an image of my Platform Manager here with. Is there anything is wrong.
    Attached Thumbnails Attached Thumbnails Attaching the Java documentation-screen2.jpg  

  6. #6
    CaptainMorgan's Avatar
    CaptainMorgan is offline Moderator
    Join Date
    Dec 2007
    Location
    NewEngland, US
    Posts
    835
    Rep Power
    8

    Default

    Yes, as I noted above- try .../docs/api as well. And I'm pretty sure the correct key combo is Alt-F1.
    Vote for the new slogan to our beloved Java Forums! (closes on September 4, 2008)
    Want to voice your opinion on your IDE/Editor of choice? Vote now!
    Got a little Capt'n in you? (drink responsibly)

  7. #7
    Eranga's Avatar
    Eranga is offline Moderator
    Join Date
    Jul 2007
    Location
    Colombo, Sri Lanka
    Posts
    11,372
    Blog Entries
    1
    Rep Power
    19

    Default

    Ok, I've tried what you say. Added docs/api as well. Still the same pal.

    Actually key combination Alt + F1 not response at all. Only Shift + F1 open the search index dialog. :(

  8. #8
    CaptainMorgan's Avatar
    CaptainMorgan is offline Moderator
    Join Date
    Dec 2007
    Location
    NewEngland, US
    Posts
    835
    Rep Power
    8

    Default

    Eranga, right click on any class keyword in a source file. The second option down you'll see you see, "Show Javadoc" which is... Alt+F1 !! If it's not opening JavaDoc with that key combination then you need to reconfigure your hotkey combination for your own system- If Shift+F1 is opening a search dialog then you'll need to change that to Alt+F1 in order for it to work. For my Linux system, Shift+F1 was performing some other function so I changed it and then Alt+F1 opened the JavaDoc.

    A couple of links that have repeated what I've said are below:
    1) Some blog
    2) From the Sun forums
    3) A blog from Java.net
    4) Have you tried the Netbeans site? (I can't find the url, but it's there on that site too)

    But once again, these links are a repeat of what I've already said.. have a look anyways.

    Best of luck.
    Vote for the new slogan to our beloved Java Forums! (closes on September 4, 2008)
    Want to voice your opinion on your IDE/Editor of choice? Vote now!
    Got a little Capt'n in you? (drink responsibly)

  9. #9
    Eranga's Avatar
    Eranga is offline Moderator
    Join Date
    Jul 2007
    Location
    Colombo, Sri Lanka
    Posts
    11,372
    Blog Entries
    1
    Rep Power
    19

    Default

    Seems something wrong with my IDE. Got an exception when I try to access Java docs. From yesterday I tried, display an exception icon on the status bar. I'm not much worried about it.

    Better to install IDE again and see what happened there.

  10. #10
    heven is offline Member
    Join Date
    Aug 2010
    Posts
    2
    Rep Power
    0

    Question the same problem

    Hi all,
    I have the same problem as above wrote.
    Looks like NetBeans doesn't work correctly with javadoc in index.
    I have Installed
    OS Ubuntu 10.4 and
    NetBeans IDE 6.9
    I follow by the steps, that was described in this forum. I looked at the links and try to find something new to solve problem but there is no any result.
    Ok, where is a problem
    1) registering documentation
    >tools> Java platform
    Choose in platforms javafx (in java doc doesn't work too in index search)
    Going in tab javadoc
    In this step I tried to do a few variants of add archive link in NetBeans.
    first of all I delete all links that didn't work (I tried before)
    and then I try different ways to add link on JavaFX API documentation
    - add link on zip archive sdk-api-doc.zip
    - or add link on unziped folder of archive sdk-api-doc
    - or add link on subfolder sdk-api-doc/javadoc (in this folder is placed index file)

    2) Ok, now this documntation should be accessible in index search
    I am restarting Netbeans
    Going in help>javadoc Index Search (or pressing Shft+F1)
    starting with a clear dialog (there is no any index list in window)
    Typing for example "Vbox"
    There is text in the window "Please wait". Looks like it buzz.
    If I trying to change search request I saw hint text - No documentation found. But I'm sure that in the pressed documentation existing answer on my request in javadoc Index. Interesting that help by Alt+F1 work and show in local in browser right place in index place.
    Can someone help me to solve this problem?
    Last edited by heven; 08-08-2010 at 10:39 PM. Reason: little mistke

  11. #11
    Fubarable's Avatar
    Fubarable is offline Moderator
    Join Date
    Jun 2008
    Posts
    19,316
    Blog Entries
    1
    Rep Power
    25

    Default

    Since it is a new problem and it is your problem, please feel free to link to or refer to this thread, but start your own new thread for this.

  12. #12
    Eranga's Avatar
    Eranga is offline Moderator
    Join Date
    Jul 2007
    Location
    Colombo, Sri Lanka
    Posts
    11,372
    Blog Entries
    1
    Rep Power
    19

Similar Threads

  1. documentation
    By mcal in forum New To Java
    Replies: 4
    Last Post: 02-07-2008, 06:20 AM
  2. Java Documentation
    By ravian in forum New To Java
    Replies: 4
    Last Post: 12-04-2007, 09:45 AM
  3. Deadlock detection tools documentation
    By goldhouse in forum Threads and Synchronization
    Replies: 0
    Last Post: 07-18-2007, 05:18 AM
  4. QueueMetrics 1.4 (Documentation)
    By JavaBean in forum Java Software
    Replies: 0
    Last Post: 06-29-2007, 12:54 PM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •