X

Geertjan's Blog

  • July 17, 2008

My 1st Contribution to NetBeans API Javadoc!

Geertjan Wielenga
Product Manager
For a very long time, Jaroslav Tulach has been asking me to add links to documentation (blogs as well as tutorials) to the NetBeans API Javadoc. I always said I would do so but then ended up being too scared—it seemed strange to add additonal Javadoc comments to code that someone else had written and I thought that somehow the build would break if I did so. (And I was also concerned that the documentation in question might be wrong or misleading, while the fact that it was linked from the Javadoc might imply that it was somehow official.)

A few days ago I promised to do so again, but this time we were in a pub and he recorded me making the promise that I would add two links the next day. So there was no way back and so two days ago I finally did it:

http://hg.netbeans.org/main/rev/55ff702a6ccd

And today you can see the result:

So, now you can expect to see a lot more cross references from NetBeans API Javadoc to various bits of documentation that should be helpful when implementing the API in question!

Join the discussion

Comments ( 5 )
  • Varun Thursday, July 17, 2008

    You should visit Pub frequently with Tulach, such initiatives are good for community ;)


  • David Strupl Thursday, July 17, 2008

    Hello, are you really sure you wanted these links in the OutlineView docs? Shouldn't they be with the Outline class itself? And the OutlineView should link to Outline somehow IMHO and also to hyperlink to the general discussion about explorers etc. But otherwise I am rather happy that someone is improving on what I have written some time ago ;-)

    Take care, David


  • Geertjan Thursday, July 17, 2008

    Where is the Javadoc for the Outline class?


  • David Strupl Thursday, July 17, 2008

    Should be here

    http://bits.netbeans.org/dev/javadoc/org-netbeans-swing-outline/overview-summary.html

    but aparently the javadoc for that jar is not generated. Maybe the jar is not official NetBeans API? Please ask Standa or Jarda about its status. Br, David


  • Wade Chandler Thursday, July 17, 2008

    Woohooooo, I am very glad to see such linkage finally make it into the JavaDocs. I remember complaining, maybe even to you, some time ago about this exact thing within the Platform APIs JavaDocs...that or it was on the Dream Team list :-S Good stuff Gj.


Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.Captcha
Oracle

Integrated Cloud Applications & Platform Services