Commits

urso  committed 1de039c

added some more initial 'documentation'

  • Participants
  • Parent commits 4a76130

Comments (0)

Files changed (3)

File documentation/generators.pdc

+Generators
+==========
+
+- every generator must be an object
+- must contain field 'arb', which is a function which will generate a value
+  for a given 'seed'
+- generators may have field 'shrink' to support shrinking.
+- if 'shrink' is not defined it is assumed to be 'null'. In either case 
+  the generator will not support shrinking
+- shrinking function must return new Array of possible shrinked values.
+- input to shrinking function is the 'seed' and the generated value to be
+  shrinked
+

File documentation/intro.pdc

+
+Introduction
+============
+
+## What is QuickCheck ##
+bla bla bla...
+
 {
 	//d: "JsDoc",
-    d: 'docs',
+    d: 'doc',
 	a: true,
 	r: 10,
-	x: "js"
+	x: "js",
+    docs: {
+        content: [
+          {src:'documentation/intro.pdc',
+           preprocess:'pandoc',
+           title: 'Introduction'},
+          {src:'documentation/generators.pdc',
+           preprocess:'pandoc',
+           title: 'Generators'},
+          {src:'documentation/example/basicuse.html',
+           title: 'Example'}
+        ]}
 }
+