Blog

Elegant Documentation Never Lies

October 15, 2010

I was taking a close look at the API documentation of the ExtJS JavaScript library the other day and I noticed something very interesting.

image

You can see that the ExtJS folks have put out some great amounts of effort into documenting their API’s. The example shown here is from the Ajax ‘class’. No big deal so far. But when you click on the name of a  method (e.g. fireEvent), you get the following:

image

You’ll dive right into the source code! Interesting approach, don’t you think?

I mean, picture this: you’re looking at the documentation of NHibernate’s ISession interface. You click on the link for the Get method and it will take you right down to the source code for that particular version of NHibernate.

Wouldn’t this be cool for the documentation of the BCL as well? Or is it just me … ? 

Profile picture of Jan Van Ryswyck

Jan Van Ryswyck

Thank you for visiting my blog. I’m a professional software developer since Y2K. A blogger since Y2K+5. Curator of the Awesome Talks list. Past organizer of the European Virtual ALT.NET meetings. Thinking and learning about all kinds of technologies since forever.

Comments

About

Thank you for visiting my website. I’m a professional software developer since Y2K. A blogger since Y2K+5. Curator of the Awesome Talks list. Past organizer of the European Virtual ALT.NET meetings. Thinking and learning about all kinds of technologies since forever.

Contact information

(+32) 496 38 00 82

infonull@nullprincipal-itnull.be