Documenting examples.

fredlund · Sep 11, 2015 · 197bc39 · 197bc39
1 parent e75073a
commit 197bc39
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -107,6 +107,17 @@ $ env ERL_LIBS=$PWD/_build/default/lib/edown rebar3 edoc
 
 
 
+## Examples ##
+
+
+The `test` directory contains a number of examples. The subdirectory
+`qc` contains a simple Quviq QuickCheck test model for the Java `HashSet`
+class -- if QuickCheck is installed the class can be verified by
+invoking the `hashset_test:test()` function. The `demo` subdirectory
+contains a simple example of using the Swing GUI library from Erlang.
+
+
+
 ## News ##
 
 The library now provides a facility to construct

diff --git a/doc/README.md b/doc/README.md
@@ -107,6 +107,17 @@ $ env ERL_LIBS=$PWD/_build/default/lib/edown rebar3 edoc
 
 
 
+## Examples ##
+
+
+The `test` directory contains a number of examples. The subdirectory
+`qc` contains a simple Quviq QuickCheck test model for the Java `HashSet`
+class -- if QuickCheck is installed the class can be verified by
+invoking the `hashset_test:test()` function. The `demo` subdirectory
+contains a simple example of using the Swing GUI library from Erlang.
+
+
+
 ## News ##
 
 The library now provides a facility to construct

diff --git a/doc/overview.edoc b/doc/overview.edoc
@@ -87,6 +87,16 @@ $ env ERL_LIBS=$PWD/_build/default/lib/edown rebar3 edoc
 '''
 </p>
 
+<h2>Examples</h2>
+
+<p>
+The ``test'' directory contains a number of examples. The subdirectory
+``qc'' contains a simple Quviq QuickCheck test model for the Java ``HashSet''
+class -- if QuickCheck is installed the class can be verified by
+invoking the ``hashset_test:test()'' function. The ``demo'' subdirectory
+contains a simple example of using the Swing GUI library from Erlang.
+</p>
+
 <h2>News</h2>
 The library now provides a facility to construct
 Java classes using Erlang, see the ``java_proxy''