My 1st Contribution to NetBeans API Javadoc!

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!

Comments:

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

Posted by Varun on July 16, 2008 at 06:31 PM PDT #

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

Posted by David Strupl on July 16, 2008 at 08:06 PM PDT #

Where is the Javadoc for the Outline class?

Posted by Geertjan on July 16, 2008 at 09:29 PM PDT #

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

Posted by David Strupl on July 16, 2008 at 10:46 PM PDT #

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.

Posted by Wade Chandler on July 17, 2008 at 11:11 AM PDT #

Post a Comment:
  • HTML Syntax: NOT allowed
About

Geertjan Wielenga (@geertjanw) is a Principal Product Manager in the Oracle Developer Tools group living & working in Amsterdam. He is a Java technology enthusiast, evangelist, trainer, speaker, and writer. He blogs here daily.

The focus of this blog is mostly on NetBeans (a development tool primarily for Java programmers), with an occasional reference to NetBeans, and sometimes diverging to topics relating to NetBeans. And then there are days when NetBeans is mentioned, just for a change.

Search

Archives
« April 2014
SunMonTueWedThuFriSat
  
12
13
14
24
25
26
27
28
29
30
   
       
Today