Skip to content

Commit

Permalink
devs (#98)
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeSimcoe authored Oct 19, 2024
1 parent 68aa75c commit bb47015
Show file tree
Hide file tree
Showing 7 changed files with 102 additions and 61 deletions.
2 changes: 1 addition & 1 deletion .github/project.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
release:
current-version: "0.8.0"
current-version: "0.8.1"
next-version: "999-SNAPSHOT"
70 changes: 19 additions & 51 deletions docs/modules/ROOT/pages/includes/quarkus-fx.adoc
Original file line number Diff line number Diff line change
@@ -1,97 +1,65 @@

:summaryTableId: quarkus-fx
:summaryTableId: quarkus-fx_quarkus-fx
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[[quarkus-fx_configuration]]link:#quarkus-fx_configuration[Configuration property]

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-fxml-root]]`link:#quarkus-fx_quarkus-fx-fxml-root[quarkus.fx.fxml-root]`

a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-views-root]] [.property-path]##link:#quarkus-fx_quarkus-fx-views-root[`quarkus.fx.views-root`]##

[.description]
--
Root location for fx resources (.fxml)

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_FXML_ROOT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_FXML_ROOT+++`
endif::add-copy-button-to-env-var[]
--|string
|`/`
Root location for fx views. The extension will look for fx views from this root directory.


a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-style-root]]`link:#quarkus-fx_quarkus-fx-style-root[quarkus.fx.style-root]`


[.description]
--
Root location for style resources (.css)

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_STYLE_ROOT+++[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_VIEWS_ROOT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_STYLE_ROOT+++`
Environment variable: `+++QUARKUS_FX_VIEWS_ROOT+++`
endif::add-copy-button-to-env-var[]
--|string
|`/`


a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-bundle-root]]`link:#quarkus-fx_quarkus-fx-bundle-root[quarkus.fx.bundle-root]`


[.description]
--
Root location for bundle resources (.properties)

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_BUNDLE_ROOT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_BUNDLE_ROOT+++`
endif::add-copy-button-to-env-var[]
--|string
|string
|`/`


a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-stylesheet-reload]]`link:#quarkus-fx_quarkus-fx-stylesheet-reload[quarkus.fx.stylesheet-reload]`

a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-stylesheet-reload]] [.property-path]##link:#quarkus-fx_quarkus-fx-stylesheet-reload[`quarkus.fx.stylesheet-reload`]##

[.description]
--
Enable (or disable) stylesheet live reload in dev mode


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_STYLESHEET_RELOAD+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_STYLESHEET_RELOAD+++`
endif::add-copy-button-to-env-var[]
--|boolean
--
|boolean
|`true`


a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-main-resources]]`link:#quarkus-fx_quarkus-fx-main-resources[quarkus.fx.main-resources]`

a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-main-resources]] [.property-path]##link:#quarkus-fx_quarkus-fx-main-resources[`quarkus.fx.main-resources`]##

[.description]
--
Location for main resources (allowing stylesheet live reload in dev mode)


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_MAIN_RESOURCES+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_MAIN_RESOURCES+++`
endif::add-copy-button-to-env-var[]
--|string
--
|string
|`src/main/resources/`

|===
|===


:!summaryTableId:
65 changes: 65 additions & 0 deletions docs/modules/ROOT/pages/includes/quarkus-fx_quarkus.fx.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
:summaryTableId: quarkus-fx_quarkus-fx
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-views-root]] [.property-path]##link:#quarkus-fx_quarkus-fx-views-root[`quarkus.fx.views-root`]##

[.description]
--
Root location for fx views. The extension will look for fx views from this root directory.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_VIEWS_ROOT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_VIEWS_ROOT+++`
endif::add-copy-button-to-env-var[]
--
|string
|`/`

a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-stylesheet-reload]] [.property-path]##link:#quarkus-fx_quarkus-fx-stylesheet-reload[`quarkus.fx.stylesheet-reload`]##

[.description]
--
Enable (or disable) stylesheet live reload in dev mode


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_STYLESHEET_RELOAD+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_STYLESHEET_RELOAD+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`true`

a|icon:lock[title=Fixed at build time] [[quarkus-fx_quarkus-fx-main-resources]] [.property-path]##link:#quarkus-fx_quarkus-fx-main-resources[`quarkus.fx.main-resources`]##

[.description]
--
Location for main resources (allowing stylesheet live reload in dev mode)


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_FX_MAIN_RESOURCES+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_FX_MAIN_RESOURCES+++`
endif::add-copy-button-to-env-var[]
--
|string
|`src/main/resources/`

|===


:!summaryTableId:
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/run-on-fx-thread.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ include::./includes/attributes.adoc[]

`@RunOnFxThread` annotation offers for a convenient way to execute the target on JavaFX UI thread (JavaFX Application Thread).

Annotation can be applied on method level or on class level (to mark all methods within a class)
Annotation can be applied at method level or at class level (to mark all methods within a class)

- Example
Example

[source,java]
----
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/ROOT/pages/startup-synchronization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ That is used in the inner `@RunOnFxThread` to ensure app is ready.
@Inject
FxStartupLatch startupLatch;
/* *** */
// Blocking until FX env is ready
startupLatch.await();
Expand Down
15 changes: 8 additions & 7 deletions docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-config-doc-maven-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<targetDirectory>${project.basedir}/modules/ROOT/pages/includes/</targetDirectory>
</configuration>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
Expand All @@ -50,13 +58,6 @@
<configuration>
<outputDirectory>${project.basedir}/modules/ROOT/pages/includes/</outputDirectory>
<resources>
<resource>
<directory>${project.basedir}/../target/asciidoc/generated/config/</directory>
<includes>
<include>quarkus-fx.adoc</include>
</includes>
<filtering>false</filtering>
</resource>
<resource>
<directory>${project.basedir}/templates/includes</directory>
<include>attributes.adoc</include>
Expand Down
5 changes: 5 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@
</systemPropertyVariables>
</configuration>
</plugin>
<plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-config-doc-maven-plugin</artifactId>
<version>${quarkus.version}</version>
</plugin>
</plugins>
</pluginManagement>
</build>
Expand Down

0 comments on commit bb47015

Please sign in to comment.