Which tool is used for generating the Ext API document?

[tookoo]

Hi, does anybody know what Ext uses to generate the API document? I suppose that Jack uses a Javadoc-like tool to generate the whole API document, which is pretty nice. I am thinking of using it in my own project. Thanks.

[Animal]

It's Jack's own software, but not yet up to his high standards for release, so it's just used internally for now. It may be that he will get time to polish it up for release.

[humpdi]

yeah iam intrested in that too :)

[MarkT]

I was wondering if it would be possible to add a Class Hierarchy to the Ext API Documentation? If the JSDoc tags are in place, it shouldn't be too hard to build. With all the new sub-classes being created, and other changes to the code, a tree view would speed up locating class members.

thanks
mark

[jon.whitcraft]

You are correct Animal, But I'm not sure if it will ever get the attention that it needs to be released.

[Animal]

I'm not sure if Jack should release it. The high documentation generation standard is one of the major advantages of Ext.

[jon.whitcraft]

I agree with you Animal.

[sjivan]

I'm not sure if Jack should release it. The high documentation generation standard is one of the major advantages of Ext.

If Ext is truly open source, then the Ext library source along with its tooling (builder, js generator etc) should be made available to the public. If not, then there's merit to articles like the one in the Dojo book where they suggest that Ext is not truly open source.

Sanjiv

[eVizions]

Since it's really not part of the Ext library itself, I don't really have a problem with Jack not releasing it. I would LIKE him to release it, but I respect his stance if he doesn't. I would, however, like the ability to view documentation on Ext 2.0, which isn't really feasible at this point, at least at the same quality as the 1.1 docs. If there was a way for SVN subscribers to have access to 2.0 docs - even if it's only generated at certain intervals, such as once a month - it would make developing with 2.0 a lot easier. Just my 2 cents.

[photoz]

If Ext is truly open source, then the Ext library source along with its tooling (builder, js generator etc) should be made available to the public. If not, then there's merit to articles like the one in the Dojo book where they suggest that Ext is not truly open source.

Sanjiv

Are you fooking serious? That is the biggest load of crap I've heard.

[brian.moeskau]

@Sanjiv: You can download the source of Ext for free, and it's licensed under the LGPL (in addition to commercial). It's technically dual-source, but I fail to understand how the Ext code base would not qualify as "open source" under anyone's definition??

The source code of the doc generator !== the source of Ext. It is a specialized tool that is constantly evolving. It is an internal tool that we don't particularly want to support as a public product at this time (maybe in the future that will change). We do have plans to provide for regular builds of the SVN docs for our subscribers, it's on our to-do list. Meanwhile, any docs that are available are in the source files, so if you have the source, you have the docs. Don't be afraid to crack open the source files when needed. The doc center is prettier and linked, but the content is the same.

[sjivan]

I'm with you on this now that I understand why the tool hasn't been released. I have no evil or malicious intent. I'm in the Ext camp :) To me it isn't a big deal either way as I don't plan on using it myself and the docs with the release are just fine. I was more curious as to why it wasn't released and support is a valid reason.

On a side note, it would be great if the API generator could be enhanced to report the API diffs between releases. It would make it a lot easier for users to cope with newer versions. Here's what I've published for users upgrading from GWT-Ext 0.9 to 0.9.1 in the Java world :

http://gwt-ext.googlecode.com/svn/trunk/site/api-diff/0.9-0.9.1/newdocs/changes.html

I think it will ease the amount of documentation that goes in the release notes of each version and manual diffs that users presently need to do to figure out what exactly changed between releases.

Sanjiv

[brian.moeskau]

Hey Sanjiv,

No harm, no foul ;). Yes, we have goals to add a diff/release notes process as well. We definitely understand that this is currently a pain point, and plan to address it for the 2.0 release. Thanks for the comments!

Brian