Updated documentation (java agent)

eficode · Sep 2, 2020 · 1781649 · 1781649
1 parent abe28b5
commit 1781649
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/AUTHORS.txt b/AUTHORS.txt
@@ -8,4 +8,4 @@ Tatu Lahtela             Find All With Pseudo Class and Find Class keywords
 Sakari Hoisko            Dockerized linux env with X
 Juho Lehtonen            Optimized docker environment.
 Juho Saarinen            Package improvements, initial monocle support, screenshot bug fix
-
+Turo Soisenniemi         Initial java agent support
diff --git a/src/main/java/libdoc-documentation.txt b/src/main/java/libdoc-documentation.txt
@@ -47,6 +47,12 @@ Experimental headless mode can be activated in remote mode at the import time by
 | *Settings* | *Value* |
 | Library | Remote | http://localhost:8270 | ${True} | WITH NAME | JavaFXLibrary |
 
+Experimental: Java agent support
+
+Library can be used as java agent. Launch application with `-javaagent:/path/to/javafxlibrary-<version>.jar`.
+Default port is 8270 and can be changed with adding `=<port>` to java agent command. Only remote library is supported.
+Using launch keyword is still required but instead of starting new application keyword initializes Stage for library.
+
 == 3. Locating JavaFX Nodes ==
 === 3.1 Locator syntax ===
 JavaFXLibrary uses TestFX lookup queries as the default way of locating JavaFX Nodes in the UI. These queries are very