incubator-flex-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Michael Schmalle <m...@teotigraphix.com>
Subject Re: Proposition :: ASDoc and compiler adjustments
Date Wed, 04 Jan 2012 23:22:06 GMT
OK,

Then I stand corrected with the SWC option I guess I don't quite  
understand how that works with the Flash Builder IDE at least.

Mike

Quoting Alex Harui <aharui@adobe.com>:

> Good question.  We will have to first figure out whether we can/should.  I
> would imagine that there is JavaDoc for Java-based projects in Apache that
> inherit from Java classes and the JavaDoc does not include packages not in
> Apache project.  Maybe the mentors can answer.
>
> We might have to make it such that when you click the link for Sprite you
> end up in the Adobe doc for flash.display.Sprite.
>
> I believe the ASDoc tool doesn't handle that now so it might require an
> update.
>
> If we decide we have to have the flash.*.* packages in our ASDoc, I will see
> what we can do to contribute those files, but keep in mind they are under
> active development so it might be better if we learn to live without them.
>
> -Alex
>
>
> On 1/4/12 3:07 PM, "Jeffry Houser" <jeffry@dot-com-it.com> wrote:
>
>>
>>   I'm curious if we'll be able to generate the full ASDocs, like what
>> are on the Adobe site without the source code for the Flash stuff.  We
>> can only go so far up the inheritance tree.
>>
>> On 1/4/2012 5:40 PM, Michael Schmalle wrote:
>>>
>>> I do not have a lot of experience with the actual compiler and asdoc
>>> tool but that has not stopped me from having fun with parsers and AST. :)
>>>
>>> I am wondering if there is any interest in creating some apis in the
>>> compiler that jive with the asdoc tool(modifying the asdoc tool). I'm
>>> going to be looking into the source code of this tomorrow so I will
>>> have a clear understanding of what the work would be.
>>>
>>> My idea is this; If we could allow public api in both tools that
>>> expose themselves through java it would allow 3rd party developers and
>>> applications that could be made to enhance the documentation process
>>> through formatters and asdoc editor applications.
>>>
>>> This a highlevel idea but I have already written such an application
>>> using the jasblocks and asblocks AST framework, that are used to
>>> create a user interface into creating asdoc comments and such through
>>> visual editing of descriptions and tags.
>>>
>>> No more typing  /** ... */ is what I mean, the editor using the AST
>>> reinserts the comment using tokens.
>>>
>>> I have found taking the actual documentation process out of the IDE's
>>> code view allows for better documentation and actual revelation that
>>> creating great docs can be fun.
>>
>
> --
> Alex Harui
> Flex SDK Team
> Adobe Systems, Inc.
> http://blogs.adobe.com/aharui
>
>




Mime
View raw message