Hi Alex,

Well I know IntelliJ uses the javadoc modules automatically. So that would be 
one :-)

And if the dita XML contains all the important information, I prefer an option 
to produce that XML and have an additional tool to to the XSLT.

Being an Apache Cocoon 1.0 user I have been using XSLT since about 1999, and 
I'm pretty fit in using it. So I would opt for creating the XSLT for producing 
output. The main benefit of this would be that we could make this XSLT 
customizable. That would be a pretty cool thing.


Von: Alex Harui <aha...@adobe.com>
Gesendet: Mittwoch, 12. Oktober 2016 18:43:55
An: dev@flex.apache.org
Betreff: Re: AW: [FalconJX] Generating ASDoc

On 10/12/16, 5:53 AM, "Christofer Dutz" <christofer.d...@c-ware.de> wrote:

>Just to join in on the discussion ... I was consumed by the Website task
>for the last few days and couldn't find the time to participate here.
>Are you talking about a cool bells&whistles version of ASDoc for which
>still the static version will be generated? Or are you thinking about
>dropping the static HTML version completely?

I have this feeling (but no proof) that ASDoc for FlexJS would be better
as an app.  Jason sort of implies that as well.  It might be easier to
interact with an app to filter down the APIs than with a pile of static
HTML content.  But if folks want static HTML, what is the easiest way to
generate the HTML?  It is tempting to teach the compiler to output the
HTML from the AST just like we output JS from the AST.  At least that
wouldn't require folks learning about a new third-party library and/or

>I would strongly suggest not to drop this as I don't know a single
>Language that doesn't produce static HTML (?)Docs. I guess it would make
>it hard for Tool vendors to integrate anything fancy into their tools. At
>least simply displaying a HTML page is easy. And when thinking about
>Maven, usually the cool libraries "xyz.jar"(or in our case "xyz.swc")
>usually come with an "xyz-source.jar" that contains the sources and a
>"xyz-javadoc.jar" (I would reccomend to call it "javadoc" even if it's
>not Java as tools like IntelliJ know how to automatically handle them).

Which Flex IDEs leverage HTML files today?  Especially packed into a
xyz-javadoc.jar?  This morning I found a link indicating that you could
pack the DITA xml files that the Flex SDK's ASDoc tool generates [1].  Do
other Flex IDEs leverage that?  That would be a reason to have the
FalconJX ASDoc generate the DITA xml format.  And if we do have DITA
output, what would be the best way to go from there to HTML?  I'm willing
to try to output DITA, but not that interested in learning about XSLT.

So, no final decisions yet, and volunteers are certainly welcome to take
the code in multiple directions.  For me, I plan to spend a few more days
on JSON output and writing a POC for an ASDOC app.  And maybe try to get
DITA output.


Reply via email to