Cleaned up examples

rife2 · Aug 21, 2023 · 945e6bc · 945e6bc
1 parent 06a2baa
commit 945e6bc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ To install, please refer to the [extensions documentation](https://github.com/ri
 To run the tests with TestNG, add the following to your build file:
 
 ```java
-@BuildCommand(summary = "Run tests with TestNG")
+@BuildCommand(summary = "Tests the project with TestNG")
 public void testng() throws Exception {
     new TestNgOperation()
     .fromProject(this)
@@ -29,7 +29,7 @@ public void testng() throws Exception {
 You could also override the default `test` command:
 
 ```java
-@BuildCommand(summary = "Run tests with TestNG")
+@BuildCommand(summary = "Tests the project with TestNG")
 public void test throws Exception {
     new TestNgOperation()
     .fromProject(this)

diff --git a/examples/src/bld/java/com/example/ExamplesBuild.java b/examples/src/bld/java/com/example/ExamplesBuild.java
@@ -9,6 +9,13 @@
 import static rife.bld.dependencies.Repository.MAVEN_CENTRAL;
 import static rife.bld.dependencies.Scope.test;
 
+/**
+ * Example build.
+ *
+ * <ul style="list-style-type:none">
+ *     <li>./bld compile test</li>
+ * </ul>
+ */
 public class ExamplesBuild extends BaseProject {
     public ExamplesBuild() {
         pkg = "com.example";
@@ -23,8 +30,8 @@ public static void main(String[] args) {
         new ExamplesBuild().start(args);
     }
 
-    @BuildCommand(summary = "Run tests with TestNG")
-    public void testng() throws Exception {
+    @BuildCommand(summary = "Tests the project with TestNG")
+    public void test() throws Exception {
         new TestNgOperation()
                 .fromProject(this)
                 .packages("com.example")