On Fri, 28 Mar 2025 05:58:19 GMT, Michael Strauß <mstra...@openjdk.org> wrote:
> > The docs on `canStartNestedEventLoop` describe its behavior already. I'm
> > not sure what further information would be useful. Would it be enough to
> > add a see also link?
>
> The exception being thrown is a behavior of `enterNestedEventLoop()`, and
> should therefore be documented with this method (`@see` is not enough). While
> that is done now with the `@throws` javadoc tag, I think it wouldn't hurt to
> be more explicit about that; much in the same way as the javadoc summary
> already contains an explicit description of the preconditions of calling the
> method.
How about adding something like this, right after the other preconditions?
* There is a finite limit on the depth of the nested event loop stack. An
exception will be thrown
* if this limit is exceeded. Applications that want to avoid an exception can
call
* {@link #canStartNestedEventLoop canStartNestedEventLoop} to see whether it is
possible
* to start one.
-------------
PR Comment: https://git.openjdk.org/jfx/pull/1741#issuecomment-2766741097
