added openjml-rac example

Spekl · Sep 1, 2015 · c9fa62a · c9fa62a
1 parent 1ae4fff
commit c9fa62a
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/docs/recipes.rst b/docs/recipes.rst
@@ -25,6 +25,34 @@ More About this Tool:
 Runtime Assertion Checking
 --------------------------
 
+Runtime Assertion Checking work by first compiling your program and then running it with the assertions added to your program. The listing below shows both checks configured. Note that the jml-java-7 specs have been configured. 
+
+.. code-block:: yaml
+
+  checks :                                                                                                 
+  - name        : openjml-rac-compile                                                                            
+    description : "OpenJML All File RAC Compile"                                                                 
+    check       : rac-compile
+    paths       : [MaybeAdd.java]                                                                        
+    classpath   : []
+    out         : out       # the compile output directory
+    tool:                                                                                                
+      name      : openjml-rac                                                                            
+
+    specs:                                                                                             
+      - name: jml-java-7                                                                                
+
+  - name        : openjml-rac-run                                                                            
+    description : "OpenJML All File RAC Check"
+    check       : rac-check
+    main        : MaybeAdd  # your main class
+    paths       : [MaybeAdd.java]                                                                        
+    classpath   : []
+    out         : out       # the compile output directory
+    tool:                                                                                                
+      name      : openjml-rac                                                                            
+
+
 
 Extended Static Checking
 ------------------------