Clever Geek Handbook

AS3 asdoc inheritance problem

I have an API that inherits from flash.display.Sprite. When I try to generate ASDocs for the API, ASdoc shows that my class inherits from flash.display.Sprite but is not referenced, or there is no clicks on the Sprite ASDoc reference. Can someone tell me what I am missing.

The command I am using in the ant script is

<java jar="${asdoc.jar}" dir="${FlexSDK.dir}/frameworks" fork="true" maxmemory="256m" failonerror="true">
   <arg line='-load-config "${flex-config.xml}"'/> 
   <arg line='-source-path ${src.dir}'/>
   <arg line='-doc-sources ${src.dir}/com'/>
   <arg line='-output ${docs.dir}'/>
   <arg value='-library-path+=${FlexSDK.dir}/frameworks'/>

Thanks in advance for your help.

+2


source to share


3 answers


ASDoc generates documentation for your classes, not the default Flash classes.



0


source


You can include Flash and Flex documents if you have access to them locally in your assembly. They are not enabled by default, but if you have access, you just need to specify a different path to the library. See this post for more details:



http://unitedmindset.com/jonbcampos/2010/01/28/building-asdocs-with-ant/

0


source


Short: Impossible because we do not have access to the source of comments for flash. *.

Long: AFAICT, ASDoc only works from source and source. Although the Flex frame classes are open source, the base framework classes are not. They are shipped as binaries in the Flex SDK: [flex_sdk] /frameworks/libs/player/10.1/playerglobal.swc. You can unzip this, but it just contains the .xml directory and the binary library.swf.

Related request: http://www.ultrashock.com/forum/viewthread/87106/

(Note that others wanting to include Flex SDK classes in their ASDocs: see [flex_sdk] /asdoc/build.xml to start customizing asdoc.)

0


source






More articles:


All Articles