You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flex.apache.org by Christofer Dutz <ch...@c-ware.de> on 2016/08/01 12:57:34 UTC
[FlexJS] ASDoc?
Hi,
as I have just added the JavaDoc generation to the Java side of the build, now I thought ... hey, how about adding ASDoc too. But unfortunately I don't recall the latest state of that. Does ASDoc in Falcon work?
Chris
AW: [FlexJS] ASDoc?
Posted by Christofer Dutz <ch...@c-ware.de>.
Ok ... replying to my self ... it turns out there are different implementations of the IASDocDelegate interface:
- NilASDocDelegate
- SimpleASDocDelegate
- FlexJSASDocDelegate
Unfortunately SimpleASDocDelegate seems to create instances of comments ... so it's a little more than Nil ... but hey ... it's called simple ... so having a look at the FlexJSASDocDelegate, this seems to be a clone of SimpleASDocDelegate.
So I guess currently I see no way in me getting this to work soon. I'll probably have to start implementing this from scratch.
Chris
________________________________
Von: Christofer Dutz <ch...@c-ware.de>
Gesendet: Montag, 1. August 2016 16:42:47
An: dev@flex.apache.org
Betreff: AW: [FlexJS] ASDoc?
Oh gee ... I can confirm it not no work ;-)
I had a look at ant and was surprised to see it using the antTasks from the normal FDK. I used the asdoc-template.xml form framework to create a new template and used that in a new ASDoc mojo. It turned out the compiler doesn't understand
doc-namespaces
or
doc-sources
So I tried feeding it the "compile-as-template.xml" content and it worked and it correctly created the: Core-0.7.0-SNAPSHOT-javadoc.jar file I was hoping to create.
Unfortunately I had a look at the file and it turned out to be somewhat identical to the compile-as version and it didn't contain a single line of ASDoc stuff.
So I compared ASDOC and COMPC and it turned out that semantically the only difference is that ASDOC has a constructor, in which an asdoc delecate is set on the workspace:
workspace.setASDocDelegate(new SimpleASDocDelegate());
Soooo ... any ideas/suggestions/whatever? Hope I didn't stumble over a "TODO: This feature has to be implemented" :-(
Chris
________________________________
Von: Alex Harui <ah...@adobe.com>
Gesendet: Montag, 1. August 2016 16:09:11
An: dev@flex.apache.org
Betreff: Re: [FlexJS] ASDoc?
On 8/1/16, 5:57 AM, "Christofer Dutz" <ch...@c-ware.de> wrote:
>Hi,
>
>
>as I have just added the JavaDoc generation to the Java side of the
>build, now I thought ... hey, how about adding ASDoc too. But
>unfortunately I don't recall the latest state of that. Does ASDoc in
>Falcon work?
ASDoc from Falcon has never been proven to work. FlexJS produces ASDoc by
using the mxmlc compiler from flex-sdk.
-Alex
AW: [FlexJS] ASDoc?
Posted by Christofer Dutz <ch...@c-ware.de>.
Oh gee ... I can confirm it not no work ;-)
I had a look at ant and was surprised to see it using the antTasks from the normal FDK. I used the asdoc-template.xml form framework to create a new template and used that in a new ASDoc mojo. It turned out the compiler doesn't understand
doc-namespaces
or
doc-sources
So I tried feeding it the "compile-as-template.xml" content and it worked and it correctly created the: Core-0.7.0-SNAPSHOT-javadoc.jar file I was hoping to create.
Unfortunately I had a look at the file and it turned out to be somewhat identical to the compile-as version and it didn't contain a single line of ASDoc stuff.
So I compared ASDOC and COMPC and it turned out that semantically the only difference is that ASDOC has a constructor, in which an asdoc delecate is set on the workspace:
workspace.setASDocDelegate(new SimpleASDocDelegate());
Soooo ... any ideas/suggestions/whatever? Hope I didn't stumble over a "TODO: This feature has to be implemented" :-(
Chris
________________________________
Von: Alex Harui <ah...@adobe.com>
Gesendet: Montag, 1. August 2016 16:09:11
An: dev@flex.apache.org
Betreff: Re: [FlexJS] ASDoc?
On 8/1/16, 5:57 AM, "Christofer Dutz" <ch...@c-ware.de> wrote:
>Hi,
>
>
>as I have just added the JavaDoc generation to the Java side of the
>build, now I thought ... hey, how about adding ASDoc too. But
>unfortunately I don't recall the latest state of that. Does ASDoc in
>Falcon work?
ASDoc from Falcon has never been proven to work. FlexJS produces ASDoc by
using the mxmlc compiler from flex-sdk.
-Alex
Re: [FlexJS] ASDoc?
Posted by Alex Harui <ah...@adobe.com>.
On 8/1/16, 5:57 AM, "Christofer Dutz" <ch...@c-ware.de> wrote:
>Hi,
>
>
>as I have just added the JavaDoc generation to the Java side of the
>build, now I thought ... hey, how about adding ASDoc too. But
>unfortunately I don't recall the latest state of that. Does ASDoc in
>Falcon work?
ASDoc from Falcon has never been proven to work. FlexJS produces ASDoc by
using the mxmlc compiler from flex-sdk.
-Alex
AW: [FlexJS] ASDoc?
Posted by Christofer Dutz <ch...@c-ware.de>.
Well I would probably create a mojo for generating the asdocs and create a reporting plugin. So the ASDoc would be handled equally to the JavaDocs in Maven (I would like to name the artifacts "javadoc" though, cause I know this way Eclipse and IntelliJ should be able to auto-detect and auto-use them.
So I'll just try and run it and have a look at what explodes :-)
Chris
________________________________
Von: Harbs <ha...@gmail.com>
Gesendet: Montag, 1. August 2016 15:18:03
An: dev@flex.apache.org
Betreff: Re: [FlexJS] ASDoc?
Peter said in May that it builds. I never really tried to get it to build myself.
Having the docs built and pushed out automatically would be great though. Having a special build from the nightly would be cool too.
On Aug 1, 2016, at 3:57 PM, Christofer Dutz <ch...@c-ware.de> wrote:
> Hi,
>
>
> as I have just added the JavaDoc generation to the Java side of the build, now I thought ... hey, how about adding ASDoc too. But unfortunately I don't recall the latest state of that. Does ASDoc in Falcon work?
>
>
> Chris
Re: [FlexJS] ASDoc?
Posted by Harbs <ha...@gmail.com>.
Peter said in May that it builds. I never really tried to get it to build myself.
Having the docs built and pushed out automatically would be great though. Having a special build from the nightly would be cool too.
On Aug 1, 2016, at 3:57 PM, Christofer Dutz <ch...@c-ware.de> wrote:
> Hi,
>
>
> as I have just added the JavaDoc generation to the Java side of the build, now I thought ... hey, how about adding ASDoc too. But unfortunately I don't recall the latest state of that. Does ASDoc in Falcon work?
>
>
> Chris