Updated Documentation

testIT-WebTester · Feb 11, 2020 · 4226962 · 4226962
1 parent 645b4f0
commit 4226962
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 63 deletions.
diff --git a/webtester-documentation/pom.xml b/webtester-documentation/pom.xml
@@ -37,37 +37,51 @@
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-surefire-plugin</artifactId>
                     <version>${version.maven.surefire.plugin}</version>
-                    <configuration>
-                        <includes>
-                            <include>**/*Documentation.java</include>
-                        </includes>
-                    </configuration>
+                    <executions>
+                        <execution>
+                            <id>documentation-tests</id>
+                            <goals>
+                                <goal>test</goal>
+                            </goals>
+                            <configuration>
+                                <includes>
+                                    <include>**/*Documentation.java</include>
+                                </includes>
+                                <skip>false</skip>
+                            </configuration>
+                        </execution>
+                    </executions>
                 </plugin>
                 <plugin>
                     <groupId>org.asciidoctor</groupId>
                     <artifactId>asciidoctor-maven-plugin</artifactId>
-                    <version>1.5.5</version>
+                    <version>1.6.0</version>
                     <executions>
                         <execution>
                             <id>generate-docs</id>
                             <phase>prepare-package</phase>
                             <goals>
                                 <goal>process-asciidoc</goal>
                             </goals>
-                            <configuration>
-                                <backend>html5</backend>
-                                <doctype>book</doctype>
-                                <sourceDocumentName>documentation.asciidoc</sourceDocumentName>
-                                <sourceHighlighter>coderay</sourceHighlighter>
-                                <attributes>
-                                    <toc>left</toc>
-                                    <toclevels>3</toclevels>
-                                    <sectlinks>true</sectlinks>
-                                    <snippets>${snippetsDirectory}</snippets>
-                                </attributes>
-                            </configuration>
                         </execution>
                     </executions>
+                    <configuration>
+                        <backend>html5</backend>
+                        <doctype>book</doctype>
+                        <sourceDocumentName>documentation.asciidoc</sourceDocumentName>
+                        <sourceHighlighter>coderay</sourceHighlighter>
+                        <attributes>
+                            <toc>left</toc>
+                            <toclevels>3</toclevels>
+                            <sectlinks>true</sectlinks>
+                            <snippets>${snippetsDirectory}</snippets>
+                        </attributes>
+                        <logHandler>
+                            <failIf>
+                                <severity>WARN</severity>
+                            </failIf>
+                        </logHandler>
+                    </configuration>
                 </plugin>
                 <plugin>
                     <groupId>org.codehaus.mojo</groupId>

diff --git a/webtester-documentation/src/main/asciidoc/chapters/annotations.asciidoc b/webtester-documentation/src/main/asciidoc/chapters/annotations.asciidoc
diff --git a/webtester-documentation/src/main/asciidoc/chapters/support-module-junit4.asciidoc b/webtester-documentation/src/main/asciidoc/chapters/support-module-junit4.asciidoc
@@ -113,6 +113,10 @@ In order for a `Browser` to be automatically navigated to an applications entry
 point before each test, the `@EntryPoint` annotation can used. The navigation at
 the beginning of each test is done whether or not a `Browser` is static!
 
+The URL can be static or contain variables. These variables are resolved against
+the annotated `Browser's` `Configuration` as `String` values. In case a variable
+could not be resolved an `IllegalStateException` is thrown before the first test.
+
 [source, java]
 ----
 @RunWith ( WebTesterJUnitRunner.class )
@@ -130,6 +134,12 @@ public class EntryPointsTest {
     @EntryPoint ( "http://www.bing.com" )
     Browser testScopedBrowser;
 
+    // Will use url provided by property
+    @Resource
+    @CreateUsing ( ... )
+    @EntryPoint("${properties.url}")
+    Browser variableUrl;
+
     ...
 
 }

diff --git a/webtester-documentation/src/main/asciidoc/chapters/support-modules.asciidoc b/webtester-documentation/src/main/asciidoc/chapters/support-modules.asciidoc
diff --git a/webtester-documentation/src/main/asciidoc/chapters/utilities.asciidoc b/webtester-documentation/src/main/asciidoc/chapters/utilities.asciidoc
diff --git a/webtester-documentation/src/main/asciidoc/documentation.asciidoc b/webtester-documentation/src/main/asciidoc/documentation.asciidoc
@@ -14,10 +14,46 @@ include::chapters/ad-hoc-finding.asciidoc[]
 
 include::chapters/event-system.asciidoc[]
 
-include::chapters/annotations.asciidoc[]
+== Annotations
 
-include::chapters/utilities.asciidoc[]
+include::chapters/annotations-action.asciidoc[]
 
-include::chapters/support-modules.asciidoc[]
+include::chapters/annotations-attribute.asciidoc[]
+
+include::chapters/annotations-identify-using.asciidoc[]
+
+include::chapters/annotations-mark.asciidoc[]
+
+include::chapters/annotations-named.asciidoc[]
+
+include::chapters/annotations-post-construct.asciidoc[]
+
+include::chapters/annotations-post-construct-must-be.asciidoc[]
+
+include::chapters/annotations-produces.asciidoc[]
+
+include::chapters/annotations-wait-until.asciidoc[]
+
+== Utilities
+
+include::chapters/utility-conditions.asciidoc[]
+
+include::chapters/utility-by-producers.asciidoc[]
+
+include::chapters/utility-mouse.asciidoc[]
+
+include::chapters/utility-waiting.asciidoc[]
+
+== Support Modules
+
+include::chapters/support-module-assertj3.asciidoc[]
+
+include::chapters/support-module-hamcrest.asciidoc[]
+
+include::chapters/support-module-junit4.asciidoc[]
+
+include::chapters/support-module-junit5.asciidoc[]
+
+include::chapters/support-module-spring4.asciidoc[]
 
 include::chapters/kotlin.asciidoc[]