You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flex.apache.org by Michael Schmalle <te...@gmail.com> on 2015/06/23 15:10:46 UTC
[FlexJS] DOM/JQuery ASDocs viewable API html online.
Hey,
I wasted 1.5 hours trying to get asdoc working with these classes and it
seems that old gramps wasn't having it. Had namespace issues, I really
don't know what is wrong, Falcon parses this stuff fine but asdoc chokes
and dies.
So, just for people to get an example of the API, I posted the HTML asdocs
of JS and JQuery SWCs up on my server for the time being.
These docs were made with My documenter I mentioned weeks before. My
program had no problem creating these. The only thing is, I never finished
it for global functions and constants, which this project uses.
So I hacked in them for the class summary and page summary, you can see
them but I have not created full clickable pages.
There is one bug in the js of the asdocs, that if you have inherited mebers
expanded, the js doesn't redraw the rows until you click it again.
Other than that, there are quite a few features I added in my docs that
ASDoc doesn't have.
http://www.teotigraphix.com/assets/apache/dom/asdoc/index.html
Mike
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by piotrz <pi...@gmail.com>.
Thank you Mike! :)
Piotr
-----
Apache Flex PMC
piotrzarzycki21@gmail.com
--
View this message in context: http://apache-flex-development.2333347.n4.nabble.com/FlexJS-DOM-JQuery-ASDocs-viewable-API-html-online-tp48154p48155.html
Sent from the Apache Flex Development mailing list archive at Nabble.com.
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by Michael Schmalle <te...@gmail.com>.
For others that use IJ, when you create a Lib for the JS swc, you can add
the;
http://www.teotigraphix.com/assets/apache/dom/asdoc/index.html
as a documentation URL to the library and you can then use Ctrl-Q to pin or
view the docs, which then shows you the function signature for all the
callbacks in the API.
Mike
On Tue, Jun 23, 2015 at 11:44 AM, Michael Schmalle <
teotigraphixllc@gmail.com> wrote:
> Yeah, don't worry about it man! I was just showing you the error.
>
> The Flex SDK asdoc emits DITA XML files and then runs XSL on the DITA
> files. So I guess, if you produced the same DITA spec from the new
> intermediate model, you could use the same XSL transformations. That would
> be the way to do it instead of concocting some new XML dialect.
>
>
> I'm doing a lot this summer with my mother-in laws house and finishing up
> those audio apps, so my time is severely limited. I actually spent way more
> time on Apache that I thought I was going to and have to make up some time.
> :)
>
> I just wanted to get this up so at least people could look at the
> available API since ASDoc won't create the docs.
>
> Mike
>
>
> On Tue, Jun 23, 2015 at 11:35 AM, Alex Harui <ah...@adobe.com> wrote:
>
>>
>>
>> On 6/23/15, 7:47 AM, "Michael Schmalle" <te...@gmail.com>
>> wrote:
>> >
>> >You can try and see if you could get asdoc working on those files but, I
>> >boiled it down and asdoc just didn't want to parse Object, it said
>> >Namespace not found and pointed to the package { declaration.
>>
>> I assume this is asdoc from the current Flex SDK? We still don’t have any
>> Falcon-based ASDoc other than what you wrote, right? I’d prefer not to
>> have to rummage through the old asdoc source.
>>
>> I thought existing asdoc generated some intermediate files then somehow
>> ran XSLT on them. I’ll put this on my list, but right now it would go
>> after trying to get my other test app working across domains and trying to
>> improve the way it looks.
>>
>> -Alex
>>
>>
>
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by Michael Schmalle <te...@gmail.com>.
Yeah, don't worry about it man! I was just showing you the error.
The Flex SDK asdoc emits DITA XML files and then runs XSL on the DITA
files. So I guess, if you produced the same DITA spec from the new
intermediate model, you could use the same XSL transformations. That would
be the way to do it instead of concocting some new XML dialect.
I'm doing a lot this summer with my mother-in laws house and finishing up
those audio apps, so my time is severely limited. I actually spent way more
time on Apache that I thought I was going to and have to make up some time.
:)
I just wanted to get this up so at least people could look at the available
API since ASDoc won't create the docs.
Mike
On Tue, Jun 23, 2015 at 11:35 AM, Alex Harui <ah...@adobe.com> wrote:
>
>
> On 6/23/15, 7:47 AM, "Michael Schmalle" <te...@gmail.com> wrote:
> >
> >You can try and see if you could get asdoc working on those files but, I
> >boiled it down and asdoc just didn't want to parse Object, it said
> >Namespace not found and pointed to the package { declaration.
>
> I assume this is asdoc from the current Flex SDK? We still don’t have any
> Falcon-based ASDoc other than what you wrote, right? I’d prefer not to
> have to rummage through the old asdoc source.
>
> I thought existing asdoc generated some intermediate files then somehow
> ran XSLT on them. I’ll put this on my list, but right now it would go
> after trying to get my other test app working across domains and trying to
> improve the way it looks.
>
> -Alex
>
>
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by Alex Harui <ah...@adobe.com>.
On 6/23/15, 7:47 AM, "Michael Schmalle" <te...@gmail.com> wrote:
>
>You can try and see if you could get asdoc working on those files but, I
>boiled it down and asdoc just didn't want to parse Object, it said
>Namespace not found and pointed to the package { declaration.
I assume this is asdoc from the current Flex SDK? We still don’t have any
Falcon-based ASDoc other than what you wrote, right? I’d prefer not to
have to rummage through the old asdoc source.
I thought existing asdoc generated some intermediate files then somehow
ran XSLT on them. I’ll put this on my list, but right now it would go
after trying to get my other test app working across domains and trying to
improve the way it looks.
-Alex
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by Michael Schmalle <te...@gmail.com>.
Yeah, it would be probably really easy for you to create XML from the
intermediate model.
But, for now I don't feel good committing it, there are things I need to
reorganize and stuff, remove hundreds of license headers etc.
I will put it on my list of things to do, on the list of many. :)
You can try and see if you could get asdoc working on those files but, I
boiled it down and asdoc just didn't want to parse Object, it said
Namespace not found and pointed to the package { declaration.
Mike
On Tue, Jun 23, 2015 at 10:38 AM, Alex Harui <ah...@adobe.com> wrote:
>
>
> On 6/23/15, 7:02 AM, "Michael Schmalle" <te...@gmail.com> wrote:
>
> >No, this is a full program.
> >
> >There is a huge amount of logic that goes into generating this stuff, same
> >would be the case for XML.
> >
> >Right now it's AST -> Intermediate Model -> Velocity -> HTML.
>
> Ah yes, I remember you mentioning "Intermediate Model”. Well, I can
> probably figure out how to go from Intermediate Model to XML, so I have no
> objections if you want to check it in. I think at least one other person
> was interested in it.
>
> -Alex
>
>
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by Alex Harui <ah...@adobe.com>.
On 6/23/15, 7:02 AM, "Michael Schmalle" <te...@gmail.com> wrote:
>No, this is a full program.
>
>There is a huge amount of logic that goes into generating this stuff, same
>would be the case for XML.
>
>Right now it's AST -> Intermediate Model -> Velocity -> HTML.
Ah yes, I remember you mentioning "Intermediate Model”. Well, I can
probably figure out how to go from Intermediate Model to XML, so I have no
objections if you want to check it in. I think at least one other person
was interested in it.
-Alex
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by Michael Schmalle <te...@gmail.com>.
No, this is a full program.
There is a huge amount of logic that goes into generating this stuff, same
would be the case for XML.
Right now it's AST -> Intermediate Model -> Velocity -> HTML.
This has nothing to do with FalconJX right now, it's purely built off the
Falcon framework of IDefinition etc.
Mike
On Tue, Jun 23, 2015 at 9:57 AM, Alex Harui <ah...@adobe.com> wrote:
> Sweet!
>
> Remind me: is your ASDoc “output” just another FalconJX emitter?
>
> I still want XML output or some other data structure for a future
> AIR-based doc viewer but I think that would be another emitter as well. I
> don’t know if anything gets lost if you go from XML to Velocity to HTML
> somehow instead of straight from AST to Velocity to HTML, but if you just
> have another emitter to check in, I’m totally fine with it. I think I’ve
> caught up with all of the other build stuff around the swcs so that I can
> help with integrating Velocity into our builds.
>
> -Alex
>
> On 6/23/15, 6:10 AM, "Michael Schmalle" <te...@gmail.com> wrote:
>
> >Hey,
> >
> >I wasted 1.5 hours trying to get asdoc working with these classes and it
> >seems that old gramps wasn't having it. Had namespace issues, I really
> >don't know what is wrong, Falcon parses this stuff fine but asdoc chokes
> >and dies.
> >
> >So, just for people to get an example of the API, I posted the HTML asdocs
> >of JS and JQuery SWCs up on my server for the time being.
> >
> >These docs were made with My documenter I mentioned weeks before. My
> >program had no problem creating these. The only thing is, I never finished
> >it for global functions and constants, which this project uses.
> >
> >So I hacked in them for the class summary and page summary, you can see
> >them but I have not created full clickable pages.
> >
> >There is one bug in the js of the asdocs, that if you have inherited
> >mebers
> >expanded, the js doesn't redraw the rows until you click it again.
> >
> >Other than that, there are quite a few features I added in my docs that
> >ASDoc doesn't have.
> >
> >http://www.teotigraphix.com/assets/apache/dom/asdoc/index.html
> >
> >Mike
>
>
Re: [FlexJS] DOM/JQuery ASDocs viewable API html online.
Posted by Alex Harui <ah...@adobe.com>.
Sweet!
Remind me: is your ASDoc “output” just another FalconJX emitter?
I still want XML output or some other data structure for a future
AIR-based doc viewer but I think that would be another emitter as well. I
don’t know if anything gets lost if you go from XML to Velocity to HTML
somehow instead of straight from AST to Velocity to HTML, but if you just
have another emitter to check in, I’m totally fine with it. I think I’ve
caught up with all of the other build stuff around the swcs so that I can
help with integrating Velocity into our builds.
-Alex
On 6/23/15, 6:10 AM, "Michael Schmalle" <te...@gmail.com> wrote:
>Hey,
>
>I wasted 1.5 hours trying to get asdoc working with these classes and it
>seems that old gramps wasn't having it. Had namespace issues, I really
>don't know what is wrong, Falcon parses this stuff fine but asdoc chokes
>and dies.
>
>So, just for people to get an example of the API, I posted the HTML asdocs
>of JS and JQuery SWCs up on my server for the time being.
>
>These docs were made with My documenter I mentioned weeks before. My
>program had no problem creating these. The only thing is, I never finished
>it for global functions and constants, which this project uses.
>
>So I hacked in them for the class summary and page summary, you can see
>them but I have not created full clickable pages.
>
>There is one bug in the js of the asdocs, that if you have inherited
>mebers
>expanded, the js doesn't redraw the rows until you click it again.
>
>Other than that, there are quite a few features I added in my docs that
>ASDoc doesn't have.
>
>http://www.teotigraphix.com/assets/apache/dom/asdoc/index.html
>
>Mike