Skip to main content
Participant
June 22, 2009
Question

ASDoc, why are features missing in the SDK?

  • June 22, 2009
  • 1 reply
  • 2328 views

I've been using ASDoc for a project of mine and I've been really trying to extract some of the functionality I see in Adobe's documentation. I've noticed that there is a lot of functionality that is either missing portions to work right, or disabled altogether. Is there a reason the full version of ASDoc is not included in the SDK?

Some of the features I'm most concerned with is local search, being able to search my documentation without using LiveDocs. I noticed there is JavaScript setup to handle a local search, but you can't enable it. I hardcoded it on, but it then references a search.html which is not included in the templates or generated by Saxon or ASDoc, so i'm confused on where this is supposed to come from.

Another big feature i'm curious about is setting a description for the overview.html page. This would be like settings comments for -package but at the Top level. there are a handful of references to overview.html in the templates, but again. Neither Saxon or ASDoc generate this. But if you go to Adobe's site, their overview.html page has the auto-generated footer so their version of ASDoc must generate the file.

Other misc features I've stumbled across were conventions, appendixes, top level, @7111211, and @review. All which aren't enabled but work in some fashion or another.

If i could just get those two main features enabled somehow it would be SUPER AWESOME. But at the least, why is all this functionality disabled/broken in the latest sdk?

- gabriel

This topic has been closed for replies.

1 reply

Adobe Employee
June 23, 2009

Hi Gabriel,

Features like local search etc are not available because no one has asked for them so far. Feel free to log an enhancement request at http://bugs.adobe.com/flex.

The other request to set package description via overview.html seems similar to http://bugs.adobe.com/jira/browse/SDK-19755, currently you can do this via Overviews_Base.xml, but when the feature request is implemented you would be able to do it using a config option.

>> Other misc features I've stumbled across were conventions, appendixes, top level, @author, and @review. All which aren't enabled but work in some >> fashion or another.

This is intentional, so we can generate asdoc faster by avoiding extra transformation processing. The current asdoc tool targets the most common use cases. If you feel these are important to you, please log enhancement requests.

Thanks,

Gaurav Jain

Flex SDK Team

Participant
June 24, 2009

Thanks for te insight, filing enhancements bugs now...