You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@royale.apache.org by Josh Tynjala <jo...@bowlerhat.dev> on 2025/04/30 21:27:18 UTC
Royale API documentation (ASDoc) updates
Hello, Royale community!
This month, I fixed some long-standing issues with Royale's API
documentation, which can be found at the following URL:
https://royale.apache.org/asdoc/
In particular, I'd like to highlight a few big things that I fixed.
- I have fixed most, if not all, page load failures that got stuck on the
"Loading..." screen. This happened unacceptably often. If you find any
more, please let me know. I'd like to clear up all of them!
- The app now resizes when the browser window resizes. Before, it was fixed
to the initial window size.
- Often, multiple vertical scroll bars were displayed, and I fixed the
layout to limit it to one.
- When clicking a package name, the main view now displays a list of all
classes in that package, instead of remaining on the page for the
previously selected class. Previously, only the bottom-left pane was
updated, and it was small enough that it could seem like nothing had
happened. This new behavior now matches Flex's original ASDoc behavior.
- I discovered that the HTTPService class in the Network library wasn't
dispatching an ioError event on the JS target at all. It was silently
ignoring failures even though the ioError event was documented as available
(so this wasn't an intentional PAYG design limitation).
- I fixed layout issues in the lists of properties/methods where all items
were given the same height because it was causing text to overflow and
overlap with other items.
- I fixed loading the "Top Level" package and classes within it, which were
completely failing.
- I improved the appearance of the top navigation bar to better match the
rest of the Royale website, which had gotten a bit out of date.
- And I fixed a bunch of other minor layout issues.
You can find the updated ASDoc build on the website right now!
https://royale.apache.org/asdoc/
--
Josh Tynjala
Re: Royale API documentation (ASDoc) updates
Posted by Greg Dove <gr...@gmail.com>.
Sorry for the late reply, but thanks (again) for your continued additions
and improvements, Josh. Very much appreciated!
On Tue, May 6, 2025 at 2:44 AM Maria Jose Esteve <mj...@iest.com> wrote:
> This is great. Thanks so much Josh, you're great 😊
>
> Hiedra
>
> -----Mensaje original-----
> De: Andrew Wetmore <co...@gmail.com>
> Enviado el: jueves, 1 de mayo de 2025 19:21
> Para: dev@royale.apache.org
> Asunto: Re: Royale API documentation (ASDoc) updates
>
> Oh, amazing. I can trust the API again
>
> On Thu, May 1, 2025 at 4:41 AM Yishay Weiss <yi...@hotmail.com>
> wrote:
>
> > +1
> > ________________________________
> > From: Piotr Zarzycki <pi...@gmail.com>
> > Sent: Thursday, May 1, 2025 6:53 AM
> > To: dev@royale.apache.org <de...@royale.apache.org>
> > Subject: Re: Royale API documentation (ASDoc) updates
> >
> > Hi Josh,
> >
> > This is awesome ! Thank you so much!
> >
> > Piotr Zarzycki
> >
> >
> > On Wed, 30 Apr 2025 at 23:27, Josh Tynjala <jo...@bowlerhat.dev>
> > wrote:
> >
> > > Hello, Royale community!
> > >
> > > This month, I fixed some long-standing issues with Royale's API
> > > documentation, which can be found at the following URL:
> > >
> > > https://royale.apache.org/asdoc/
> > >
> > > In particular, I'd like to highlight a few big things that I fixed.
> > >
> > > - I have fixed most, if not all, page load failures that got stuck
> > > on the "Loading..." screen. This happened unacceptably often. If you
> > > find any more, please let me know. I'd like to clear up all of them!
> > >
> > > - The app now resizes when the browser window resizes. Before, it
> > > was
> > fixed
> > > to the initial window size.
> > >
> > > - Often, multiple vertical scroll bars were displayed, and I fixed
> > > the layout to limit it to one.
> > >
> > > - When clicking a package name, the main view now displays a list of
> > > all classes in that package, instead of remaining on the page for
> > > the previously selected class. Previously, only the bottom-left pane
> > > was updated, and it was small enough that it could seem like nothing
> > > had happened. This new behavior now matches Flex's original ASDoc
> behavior.
> > >
> > > - I discovered that the HTTPService class in the Network library
> > > wasn't dispatching an ioError event on the JS target at all. It was
> > > silently ignoring failures even though the ioError event was
> > > documented as
> > available
> > > (so this wasn't an intentional PAYG design limitation).
> > >
> > > - I fixed layout issues in the lists of properties/methods where all
> > items
> > > were given the same height because it was causing text to overflow
> > > and overlap with other items.
> > >
> > > - I fixed loading the "Top Level" package and classes within it,
> > > which
> > were
> > > completely failing.
> > >
> > > - I improved the appearance of the top navigation bar to better
> > > match the rest of the Royale website, which had gotten a bit out of
> date.
> > >
> > > - And I fixed a bunch of other minor layout issues.
> > >
> > > You can find the updated ASDoc build on the website right now!
> > >
> > > https://royale.apache.org/asdoc/
> > >
> > > --
> > > Josh Tynjala
> > >
> >
>
>
> --
> Andrew Wetmore
>
> Editor, Moose House Publications <https://moosehousepress.com/>
> Editor-Writer, The Apache Software Foundation <https://apache.org/>
>
RE: Royale API documentation (ASDoc) updates
Posted by Maria Jose Esteve <mj...@iest.com>.
This is great. Thanks so much Josh, you're great 😊
Hiedra
-----Mensaje original-----
De: Andrew Wetmore <co...@gmail.com>
Enviado el: jueves, 1 de mayo de 2025 19:21
Para: dev@royale.apache.org
Asunto: Re: Royale API documentation (ASDoc) updates
Oh, amazing. I can trust the API again
On Thu, May 1, 2025 at 4:41 AM Yishay Weiss <yi...@hotmail.com> wrote:
> +1
> ________________________________
> From: Piotr Zarzycki <pi...@gmail.com>
> Sent: Thursday, May 1, 2025 6:53 AM
> To: dev@royale.apache.org <de...@royale.apache.org>
> Subject: Re: Royale API documentation (ASDoc) updates
>
> Hi Josh,
>
> This is awesome ! Thank you so much!
>
> Piotr Zarzycki
>
>
> On Wed, 30 Apr 2025 at 23:27, Josh Tynjala <jo...@bowlerhat.dev>
> wrote:
>
> > Hello, Royale community!
> >
> > This month, I fixed some long-standing issues with Royale's API
> > documentation, which can be found at the following URL:
> >
> > https://royale.apache.org/asdoc/
> >
> > In particular, I'd like to highlight a few big things that I fixed.
> >
> > - I have fixed most, if not all, page load failures that got stuck
> > on the "Loading..." screen. This happened unacceptably often. If you
> > find any more, please let me know. I'd like to clear up all of them!
> >
> > - The app now resizes when the browser window resizes. Before, it
> > was
> fixed
> > to the initial window size.
> >
> > - Often, multiple vertical scroll bars were displayed, and I fixed
> > the layout to limit it to one.
> >
> > - When clicking a package name, the main view now displays a list of
> > all classes in that package, instead of remaining on the page for
> > the previously selected class. Previously, only the bottom-left pane
> > was updated, and it was small enough that it could seem like nothing
> > had happened. This new behavior now matches Flex's original ASDoc behavior.
> >
> > - I discovered that the HTTPService class in the Network library
> > wasn't dispatching an ioError event on the JS target at all. It was
> > silently ignoring failures even though the ioError event was
> > documented as
> available
> > (so this wasn't an intentional PAYG design limitation).
> >
> > - I fixed layout issues in the lists of properties/methods where all
> items
> > were given the same height because it was causing text to overflow
> > and overlap with other items.
> >
> > - I fixed loading the "Top Level" package and classes within it,
> > which
> were
> > completely failing.
> >
> > - I improved the appearance of the top navigation bar to better
> > match the rest of the Royale website, which had gotten a bit out of date.
> >
> > - And I fixed a bunch of other minor layout issues.
> >
> > You can find the updated ASDoc build on the website right now!
> >
> > https://royale.apache.org/asdoc/
> >
> > --
> > Josh Tynjala
> >
>
--
Andrew Wetmore
Editor, Moose House Publications <https://moosehousepress.com/> Editor-Writer, The Apache Software Foundation <https://apache.org/>
Re: Royale API documentation (ASDoc) updates
Posted by Andrew Wetmore <co...@gmail.com>.
Oh, amazing. I can trust the API again
On Thu, May 1, 2025 at 4:41 AM Yishay Weiss <yi...@hotmail.com> wrote:
> +1
> ________________________________
> From: Piotr Zarzycki <pi...@gmail.com>
> Sent: Thursday, May 1, 2025 6:53 AM
> To: dev@royale.apache.org <de...@royale.apache.org>
> Subject: Re: Royale API documentation (ASDoc) updates
>
> Hi Josh,
>
> This is awesome ! Thank you so much!
>
> Piotr Zarzycki
>
>
> On Wed, 30 Apr 2025 at 23:27, Josh Tynjala <jo...@bowlerhat.dev>
> wrote:
>
> > Hello, Royale community!
> >
> > This month, I fixed some long-standing issues with Royale's API
> > documentation, which can be found at the following URL:
> >
> > https://royale.apache.org/asdoc/
> >
> > In particular, I'd like to highlight a few big things that I fixed.
> >
> > - I have fixed most, if not all, page load failures that got stuck on the
> > "Loading..." screen. This happened unacceptably often. If you find any
> > more, please let me know. I'd like to clear up all of them!
> >
> > - The app now resizes when the browser window resizes. Before, it was
> fixed
> > to the initial window size.
> >
> > - Often, multiple vertical scroll bars were displayed, and I fixed the
> > layout to limit it to one.
> >
> > - When clicking a package name, the main view now displays a list of all
> > classes in that package, instead of remaining on the page for the
> > previously selected class. Previously, only the bottom-left pane was
> > updated, and it was small enough that it could seem like nothing had
> > happened. This new behavior now matches Flex's original ASDoc behavior.
> >
> > - I discovered that the HTTPService class in the Network library wasn't
> > dispatching an ioError event on the JS target at all. It was silently
> > ignoring failures even though the ioError event was documented as
> available
> > (so this wasn't an intentional PAYG design limitation).
> >
> > - I fixed layout issues in the lists of properties/methods where all
> items
> > were given the same height because it was causing text to overflow and
> > overlap with other items.
> >
> > - I fixed loading the "Top Level" package and classes within it, which
> were
> > completely failing.
> >
> > - I improved the appearance of the top navigation bar to better match the
> > rest of the Royale website, which had gotten a bit out of date.
> >
> > - And I fixed a bunch of other minor layout issues.
> >
> > You can find the updated ASDoc build on the website right now!
> >
> > https://royale.apache.org/asdoc/
> >
> > --
> > Josh Tynjala
> >
>
--
Andrew Wetmore
Editor, Moose House Publications <https://moosehousepress.com/>
Editor-Writer, The Apache Software Foundation <https://apache.org/>
Re: Royale API documentation (ASDoc) updates
Posted by Yishay Weiss <yi...@hotmail.com>.
+1
________________________________
From: Piotr Zarzycki <pi...@gmail.com>
Sent: Thursday, May 1, 2025 6:53 AM
To: dev@royale.apache.org <de...@royale.apache.org>
Subject: Re: Royale API documentation (ASDoc) updates
Hi Josh,
This is awesome ! Thank you so much!
Piotr Zarzycki
On Wed, 30 Apr 2025 at 23:27, Josh Tynjala <jo...@bowlerhat.dev>
wrote:
> Hello, Royale community!
>
> This month, I fixed some long-standing issues with Royale's API
> documentation, which can be found at the following URL:
>
> https://royale.apache.org/asdoc/
>
> In particular, I'd like to highlight a few big things that I fixed.
>
> - I have fixed most, if not all, page load failures that got stuck on the
> "Loading..." screen. This happened unacceptably often. If you find any
> more, please let me know. I'd like to clear up all of them!
>
> - The app now resizes when the browser window resizes. Before, it was fixed
> to the initial window size.
>
> - Often, multiple vertical scroll bars were displayed, and I fixed the
> layout to limit it to one.
>
> - When clicking a package name, the main view now displays a list of all
> classes in that package, instead of remaining on the page for the
> previously selected class. Previously, only the bottom-left pane was
> updated, and it was small enough that it could seem like nothing had
> happened. This new behavior now matches Flex's original ASDoc behavior.
>
> - I discovered that the HTTPService class in the Network library wasn't
> dispatching an ioError event on the JS target at all. It was silently
> ignoring failures even though the ioError event was documented as available
> (so this wasn't an intentional PAYG design limitation).
>
> - I fixed layout issues in the lists of properties/methods where all items
> were given the same height because it was causing text to overflow and
> overlap with other items.
>
> - I fixed loading the "Top Level" package and classes within it, which were
> completely failing.
>
> - I improved the appearance of the top navigation bar to better match the
> rest of the Royale website, which had gotten a bit out of date.
>
> - And I fixed a bunch of other minor layout issues.
>
> You can find the updated ASDoc build on the website right now!
>
> https://royale.apache.org/asdoc/
>
> --
> Josh Tynjala
>
Re: Royale API documentation (ASDoc) updates
Posted by Piotr Zarzycki <pi...@gmail.com>.
Hi Josh,
This is awesome ! Thank you so much!
Piotr Zarzycki
On Wed, 30 Apr 2025 at 23:27, Josh Tynjala <jo...@bowlerhat.dev>
wrote:
> Hello, Royale community!
>
> This month, I fixed some long-standing issues with Royale's API
> documentation, which can be found at the following URL:
>
> https://royale.apache.org/asdoc/
>
> In particular, I'd like to highlight a few big things that I fixed.
>
> - I have fixed most, if not all, page load failures that got stuck on the
> "Loading..." screen. This happened unacceptably often. If you find any
> more, please let me know. I'd like to clear up all of them!
>
> - The app now resizes when the browser window resizes. Before, it was fixed
> to the initial window size.
>
> - Often, multiple vertical scroll bars were displayed, and I fixed the
> layout to limit it to one.
>
> - When clicking a package name, the main view now displays a list of all
> classes in that package, instead of remaining on the page for the
> previously selected class. Previously, only the bottom-left pane was
> updated, and it was small enough that it could seem like nothing had
> happened. This new behavior now matches Flex's original ASDoc behavior.
>
> - I discovered that the HTTPService class in the Network library wasn't
> dispatching an ioError event on the JS target at all. It was silently
> ignoring failures even though the ioError event was documented as available
> (so this wasn't an intentional PAYG design limitation).
>
> - I fixed layout issues in the lists of properties/methods where all items
> were given the same height because it was causing text to overflow and
> overlap with other items.
>
> - I fixed loading the "Top Level" package and classes within it, which were
> completely failing.
>
> - I improved the appearance of the top navigation bar to better match the
> rest of the Royale website, which had gotten a bit out of date.
>
> - And I fixed a bunch of other minor layout issues.
>
> You can find the updated ASDoc build on the website right now!
>
> https://royale.apache.org/asdoc/
>
> --
> Josh Tynjala
>