Re: [External] : Re: Mention of the CSS properties in JavaDocs
> So I suppose going back to a custom doclet again will not be a preferable solution. You're right; this would not be a preferred solution. -- Kevin On 2/15/2022 9:37 PM, Anirvan Sarkar wrote: JavaFX 2 provided a custom doclet [1] but this was not required since JavaFX 8 (JDK 8). If a custom doclet is introduced again, we need to modify build scripts / IDE settings, etc. which is not required since JDK 12 [2]. So I suppose going back to a custom doclet again will not be a preferable solution. [1] : https://docs.oracle.com/javafx/2/doclet/jfxpub-doclet.htm [2] : https://bugs.openjdk.java.net/browse/JDK-8208532 On Mon, 14 Feb 2022 at 02:34, Scott Palmer wrote: Would it be a custom doclet that was part of the OpenJFX project and require no changes to the javadoc tool? Scott > On Feb 12, 2022, at 9:52 AM, Kevin Rushforth wrote: > > While something like this could be handy, I doubt that adding this much knowledge of JavaFX into the javadoc tool would gain any traction. > > -- Kevin > > > On 2/9/2022 7:11 AM, Nir Lisker wrote: >> Hi, >> >> When reviewing the docs changes to TabPane, I saw that some properties >> mention the CSS that is related to them. I was wondering if we could >> standardize it through something like a @css tag that is given the css >> string constant, or read automatically through the CssMetaData. >> >> As an example: >> >> /** >> * Specifies the maximum width of a tab. >> * ... >> * @css -fx-tab-max-width >> * @defaultValue 10 >> */ >> >> If the javadoc tool has access to these during its runtime, it can read the >> string by looking in the getCssMetaData() override of the property and then >> read the first argument of the CssMetaData constructor. >> >> Thoughts? > -- Anirvan
Re: Mention of the CSS properties in JavaDocs
JavaFX 2 provided a custom doclet [1] but this was not required since JavaFX 8 (JDK 8). If a custom doclet is introduced again, we need to modify build scripts / IDE settings, etc. which is not required since JDK 12 [2]. So I suppose going back to a custom doclet again will not be a preferable solution. [1] : https://docs.oracle.com/javafx/2/doclet/jfxpub-doclet.htm [2] : https://bugs.openjdk.java.net/browse/JDK-8208532 On Mon, 14 Feb 2022 at 02:34, Scott Palmer wrote: > Would it be a custom doclet that was part of the OpenJFX project and > require no changes to the javadoc tool? > > Scott > > > On Feb 12, 2022, at 9:52 AM, Kevin Rushforth > wrote: > > > > While something like this could be handy, I doubt that adding this much > knowledge of JavaFX into the javadoc tool would gain any traction. > > > > -- Kevin > > > > > > On 2/9/2022 7:11 AM, Nir Lisker wrote: > >> Hi, > >> > >> When reviewing the docs changes to TabPane, I saw that some properties > >> mention the CSS that is related to them. I was wondering if we could > >> standardize it through something like a @css tag that is given the css > >> string constant, or read automatically through the CssMetaData. > >> > >> As an example: > >> > >> /** > >> * Specifies the maximum width of a tab. > >> * ... > >> * @css -fx-tab-max-width > >> * @defaultValue 10 > >> */ > >> > >> If the javadoc tool has access to these during its runtime, it can read > the > >> string by looking in the getCssMetaData() override of the property and > then > >> read the first argument of the CssMetaData constructor. > >> > >> Thoughts? > > > > -- Anirvan
Re: Mention of the CSS properties in JavaDocs
Would it be a custom doclet that was part of the OpenJFX project and require no changes to the javadoc tool? Scott > On Feb 12, 2022, at 9:52 AM, Kevin Rushforth > wrote: > > While something like this could be handy, I doubt that adding this much > knowledge of JavaFX into the javadoc tool would gain any traction. > > -- Kevin > > > On 2/9/2022 7:11 AM, Nir Lisker wrote: >> Hi, >> >> When reviewing the docs changes to TabPane, I saw that some properties >> mention the CSS that is related to them. I was wondering if we could >> standardize it through something like a @css tag that is given the css >> string constant, or read automatically through the CssMetaData. >> >> As an example: >> >> /** >> * Specifies the maximum width of a tab. >> * ... >> * @css -fx-tab-max-width >> * @defaultValue 10 >> */ >> >> If the javadoc tool has access to these during its runtime, it can read the >> string by looking in the getCssMetaData() override of the property and then >> read the first argument of the CssMetaData constructor. >> >> Thoughts? >
Re: [External] : Re: Mention of the CSS properties in JavaDocs
Support for JavaFX properties was folded into the standard doclet in JDK 8, so we haven't used a modified javadoc tool since then. It was initially under a "-javafx" option. That option was eliminated, and the JavaFX property support is enabled and active for classes that implement javafx.beans.Observable interface from the javafx.base module. It has been improved several times recently, but the JavaFX-specific knowledge in the doclet is limited to support for properties. -- Kevin On 2/12/2022 10:11 AM, Nir Lisker wrote: How does it handle JavaFX-specific properties? I thought that JavaFX uses a modified javadoc tool. On Sat, Feb 12, 2022 at 4:52 PM Kevin Rushforth wrote: While something like this could be handy, I doubt that adding this much knowledge of JavaFX into the javadoc tool would gain any traction. -- Kevin On 2/9/2022 7:11 AM, Nir Lisker wrote: > Hi, > > When reviewing the docs changes to TabPane, I saw that some properties > mention the CSS that is related to them. I was wondering if we could > standardize it through something like a @css tag that is given the css > string constant, or read automatically through the CssMetaData. > > As an example: > > /** > * Specifies the maximum width of a tab. > * ... > * @css -fx-tab-max-width > * @defaultValue 10 > */ > > If the javadoc tool has access to these during its runtime, it can read the > string by looking in the getCssMetaData() override of the property and then > read the first argument of the CssMetaData constructor. > > Thoughts?
Re: Mention of the CSS properties in JavaDocs
How does it handle JavaFX-specific properties? I thought that JavaFX uses a modified javadoc tool. On Sat, Feb 12, 2022 at 4:52 PM Kevin Rushforth wrote: > While something like this could be handy, I doubt that adding this much > knowledge of JavaFX into the javadoc tool would gain any traction. > > -- Kevin > > > On 2/9/2022 7:11 AM, Nir Lisker wrote: > > Hi, > > > > When reviewing the docs changes to TabPane, I saw that some properties > > mention the CSS that is related to them. I was wondering if we could > > standardize it through something like a @css tag that is given the css > > string constant, or read automatically through the CssMetaData. > > > > As an example: > > > > /** > > * Specifies the maximum width of a tab. > > * ... > > * @css -fx-tab-max-width > > * @defaultValue 10 > > */ > > > > If the javadoc tool has access to these during its runtime, it can read > the > > string by looking in the getCssMetaData() override of the property and > then > > read the first argument of the CssMetaData constructor. > > > > Thoughts? > >
Re: Mention of the CSS properties in JavaDocs
While something like this could be handy, I doubt that adding this much knowledge of JavaFX into the javadoc tool would gain any traction. -- Kevin On 2/9/2022 7:11 AM, Nir Lisker wrote: Hi, When reviewing the docs changes to TabPane, I saw that some properties mention the CSS that is related to them. I was wondering if we could standardize it through something like a @css tag that is given the css string constant, or read automatically through the CssMetaData. As an example: /** * Specifies the maximum width of a tab. * ... * @css -fx-tab-max-width * @defaultValue 10 */ If the javadoc tool has access to these during its runtime, it can read the string by looking in the getCssMetaData() override of the property and then read the first argument of the CssMetaData constructor. Thoughts?
