From 16bb16ab21b309de356e577c1fce121ab1e4e79a Mon Sep 17 00:00:00 2001 From: Tom Faulhaber Date: Fri, 28 Aug 2009 10:38:12 -0700 Subject: Updated documentation for commit cdbfc8de5723bc352ee4fb54bd3eeb4502835362 --- accumulators-api.html | 2 +- agent-utils-api.html | 2 +- api-index.html | 38 +- api-index.json | 304 +++++++++++++++ base64-api.html | 2 +- classpath-api.html | 2 +- combinatorics-api.html | 2 +- command-line-api.html | 2 +- complex-numbers-api.html | 2 +- cond-api.html | 2 +- condition-api.html | 2 +- core-api.html | 2 +- dataflow-api.html | 2 +- datalog-api.html | 2 +- def-api.html | 2 +- doc/datalog.html | 2 +- doc/pprint/CommonLispFormat.html | 2 +- doc/pprint/PrettyPrinting.html | 2 +- duck-streams-api.html | 2 +- error-kit-api.html | 2 +- except-api.html | 2 +- fcase-api.html | 2 +- find-namespaces-api.html | 2 +- fnmap-api.html | 2 +- gen-html-docs-api.html | 2 +- generic.arithmetic-api.html | 2 +- generic.collection-api.html | 2 +- generic.comparison-api.html | 2 +- generic.functor-api.html | 2 +- generic.math-functions-api.html | 2 +- graph-api.html | 2 +- greatest-least-api.html | 2 +- http.agent-api.html | 2 +- http.connection-api.html | 2 +- import-static-api.html | 2 +- index.html | 31 +- jar-api.html | 2 +- java-utils-api.html | 2 +- javadoc.browse-api.html | 2 +- jmx-api.html | 2 +- json.read-api.html | 2 +- json.write-api.html | 2 +- lazy-seqs-api.html | 2 +- lazy-xml-api.html | 2 +- logging-api.html | 2 +- macro-utils-api.html | 2 +- macros-api.html | 2 +- map-utils-api.html | 2 +- math-api.html | 2 +- miglayout-api.html | 2 +- mmap-api.html | 2 +- mock-api.html | 2 +- monadic-io-streams-api.html | 2 +- monads-api.html | 2 +- ns-utils-api.html | 2 +- pprint-api.html | 2 +- probabilities.finite-distributions-api.html | 2 +- probabilities.monte-carlo-api.html | 2 +- probabilities.random-numbers-api.html | 2 +- profile-api.html | 2 +- prxml-api.html | 2 +- repl-ln-api.html | 2 +- repl-utils-api.html | 2 +- seq-utils-api.html | 2 +- server-socket-api.html | 2 +- set-api.html | 2 +- shell-out-api.html | 2 +- singleton-api.html | 2 +- sql-api.html | 2 +- str-utils-api.html | 2 +- str-utils2-api.html | 2 +- stream-utils-api.html | 2 +- swing-utils-api.html | 2 +- test-is-api.html | 580 ++++++++++++++++++++++++++++ trace-api.html | 2 +- types-api.html | 2 +- with-ns-api.html | 2 +- zip-filter-api.html | 2 +- 78 files changed, 1024 insertions(+), 77 deletions(-) create mode 100644 test-is-api.html diff --git a/accumulators-api.html b/accumulators-api.html index d5ec0319..621cc625 100644 --- a/accumulators-api.html +++ b/accumulators-api.html @@ -34,7 +34,7 @@ namespace. API Index
Namespaces: diff --git a/agent-utils-api.html b/agent-utils-api.html index 4b68181c..825641ab 100644 --- a/agent-utils-api.html +++ b/agent-utils-api.html @@ -34,7 +34,7 @@ namespace. API Index
Namespaces: diff --git a/api-index.html b/api-index.html index c83cfe2f..474336f7 100644 --- a/api-index.html +++ b/api-index.html @@ -34,7 +34,7 @@ namespace. API Index
Namespaces: @@ -98,13 +98,17 @@ Shortcuts:
ancestors function zip-filter Returns a lazy sequence of all ancestors of locati... append-spit function duck-streams Like spit but appends to file.. append-writer function duck-streams Like writer but opens file for appending. Does no... + apply-template function test-is Replaces _1, _2, _3, etc. in expr with correspondi... approx= function generic.math-functions Return true if the absolute value of the diffe... + are macro test-is Checks multiple assertions with a template express... as-file multimethod java-utils Interpret a String or a java.io.File as a File. Bu... as-object-name multimethod jmx Interpret an object as a JMX ObjectName.. as-properties function java-utils Convert any seq of pairs to a java.utils.Propertie... as-str function java-utils Like clojure.core/str, but if an argument is a key... as-url multimethod java-utils Coerces argument (URL, URI, or String) to a java.n... asin multimethod generic.math-functions Return the asin of x.. + assert-any function test-is Returns generic assertion code for any test, inclu... + assert-predicate function test-is Returns generic assertion code for any functional ... assoc multimethod generic.collection Returns a new collection in which the values corre... atan multimethod generic.math-functions Return the atan of x.. atan2 multimethod generic.math-functions Return the atan2 of x and y.. @@ -166,6 +170,7 @@ Shortcuts:
 compile-format function pprint Compiles format-str into a compiled format which c... component-graph function graph Given a graph, perhaps with cycles, return a reduc... components function miglayout Returns a map from id (a keyword) to component for... + compose-fixtures function test-is Composes two fixture functions, creating a new fix... cond-dist-m var probabilities.finite-distributions Variant of the dist monad that can... cond-let macro cond Takes a binding-form and a set of test/expr pairs.... cond-prob function probabilities.finite-distributions Returns the conditional probabilit... @@ -203,6 +208,8 @@ Shortcuts:
 defstruct- macro def Same as defstruct but yields a private definition. defsymbolmacro macro macro-utils Define a symbol macro. Because symbol macros are n... deftemplate macro macro-utils Define a macro that expands into forms after repla... + deftest macro test-is Defines a test function with no arguments. Test f... + deftest- macro test-is Like deftest but creates a private var.. deftrace macro trace Use in place of defn; traces each call/return of t... deftype macro types Define a data type by a type tag (a namespace-qual... deftype- macro types Same as deftype but the constructor is private.. @@ -225,6 +232,7 @@ Shortcuts:
 do-swing macro swing-utils Executes body in the Swing event thread asynchrono... do-swing* function swing-utils Runs thunk in the Swing event thread according to ... do-swing-and-wait macro swing-utils Executes body in the Swing event thread synchronou... + do-template macro test-is Repeatedly evaluates template expr (in a do block)... dochars macro str-utils2 bindings => [name string] Repeatedly executes bod... docodepoints macro str-utils2 bindings => [name string] Repeatedly executes bod... docs macro ns-utils Prints documentation for the public vars in a name... @@ -280,12 +288,14 @@ Shortcuts:
 fetch-val function monads Return a state-monad function that assumes the sta... fibs function lazy-seqs Returns a lazy sequence of all the Fibonacci numbe... file function java-utils Returns a java.io.File from string or file args.. + file-position function test-is Returns a vector [filename line-number] for the nt... file-str function duck-streams Concatenates args as strings and returns a java.io... filenames-in-jar function jar Returns a sequence of Strings naming the non-direc... fill-queue function seq-utils filler-func will be called in another thread with ... find-clojure-sources-in-dir function find-namespaces Searches recursively under dir for Clojure source ... find-connection function sql Returns the current database connection (or nil if... find-first function seq-utils Returns the first item of coll for which (pred ite... + find-holes function test-is Recursively finds all symbols starting with _ in f... find-javadoc-url function repl-utils Searches for a URL for the given class name. Trie... find-namespaces-in-dir function find-namespaces Searches dir recursively for (ns ...) declarations... find-namespaces-in-jarfile function find-namespaces Searches the JAR file for Clojure source files con... @@ -293,8 +303,11 @@ Shortcuts:
 find-ns-decls-in-dir function find-namespaces Searches dir recursively for (ns ...) declarations... find-ns-decls-in-jarfile function find-namespaces Searches the JAR file for Clojure source files con... find-ns-decls-on-classpath function find-namespaces Searches CLASSPATH (both directories and JAR files... + find-pure-exprs function test-is Recursively finds all sub-expressions in form that... + find-symbols function test-is Recursively finds all symbols in form.. fixed-point function graph Repeatedly apply fun to data until (equal old-data... flatten function seq-utils Takes any nested combination of sequential things ... + flatten-map function test-is Transforms a map into a vector like [key value key... floor multimethod generic.math-functions Return the floor of x.. floor multimethod math (floor n) returns the greatest integer less than o... flush function monadic-io-streams Flush. @@ -304,6 +317,7 @@ Shortcuts:
 formatter-out macro pprint Makes a function which can directly run format-in.... frequencies function seq-utils Returns a map from distinct items in coll to the n... fresh-line function pprint Make a newline if the Writer is not already at the... + function? function test-is Returns true if argument is a function or a symbol...

G

@@ -318,6 +332,7 @@ Shortcuts:
get-neighbors function graph Get the neighbors of a node.. get-ns function ns-utils Returns the namespace named by ns-sym or throws if... get-old-value function dataflow Looks up an old value. + get-possibly-unbound-var function test-is Like var-get but returns nil if the var is unbound... get-source function repl-utils Returns a string of the source code for the given ... get-source-cells function dataflow Returns a collection of source cells from the data... get-system-property function java-utils Get a system property.. @@ -355,6 +370,7 @@ Shortcuts:
 impl-write! var logging Implementation-specific write of a log message. En... import-static macro import-static Imports the named static fields and/or static meth... in-case macro fcase Like case, but test expressions are sequences. Th... + inc-report-counter function test-is Increments the named counter in *report-counters*,... includes? function seq-utils Returns true if coll contains something equal (wit... indexed function seq-utils Returns a lazy sequence of [index, item] pairs, wh... info macro logging Logs a message at the info level.. @@ -363,6 +379,7 @@ Shortcuts:
 insert-values function sql Inserts rows into a table with values for specifie... instance-case macro fcase Like case, but the test expressions are Java class... into multimethod generic.collection Returns a new coll consisting of to-coll with all ... + is macro test-is Generic assertion macro. 'form' is any predicate ... is-rollback-only function sql Returns true if the outermost transaction will rol...
@@ -374,6 +391,7 @@ Shortcuts:
jmx->clj multimethod jmx Coerce JMX data structures into Clojure data. Hand... jmx-url function jmx Build a JMX URL from options.. join function str-utils2 Returns a string of all elements in coll, separate... + join-fixtures function test-is Composes a collection of fixtures, in order. Alwa... join-with function probabilities.finite-distributions Returns the distribution of (f x y... json-str function json.write Converts x to a JSON-formatted string.. @@ -384,7 +402,8 @@ Shortcuts:

L

- *local-javadocs*             var           repl-utils         Ref to a list of local paths for Javadoc-generated...
+ *load-tests*                 var           test-is            True by default.  If set to false, no test functio...
+ *local-javadocs*             var           repl-utils         Ref to a list of local paths for Javadoc-generated...
  *logging-agent*              var           logging            The default agent used for performing logging durn...
  lazy-get                     macro         map-utils          Like get, but doesn't evaluate not-found unless it...
  lazy-walk                    function      graph              Return a lazy sequence of the nodes of a graph sta...
@@ -570,6 +589,7 @@ Shortcuts:

  repl-prompt                  function      repl-ln            Returns the current repl prompt based on this repl...
  replace                      multimethod   str-utils2         Replaces all instances of pattern in string with r...
  replace-first                multimethod   str-utils2         Replaces the first instance of pattern in s with r...
+ report                       multimethod   test-is            Generic reporting function, may be overridden to p...
  request-body                 function      http.agent         Returns the HTTP request body given to this HTTP a...
  request-headers              function      http.agent         Returns the request headers specified for this HTT...
  request-uri                  function      http.agent         Returns the URI/URL requested by this HTTP agent, ...
@@ -586,13 +606,16 @@ Shortcuts:

  rtrim                        function      str-utils2         Removes whitespace from the right side of string..
  run                          macro         repl-utils         Loads the specified namespace and invokes its "mai...
  run*                         function      repl-utils         Loads the specified namespace and invokes its "mai...
+ run-all-tests                function      test-is            Runs all tests in all namespaces; prints results. ...
  run-cont                     function      monads             Execute the computation c in the cont monad and re...
+ run-tests                    function      test-is            Runs all tests in the given namespaces; prints res...
  run-work-plan                function      datalog            Given a work plan, a database, and some query bind...

S

  *simple-dispatch*            multimethod   pprint             The pretty print dispatch function for simple data...
+ *stack-trace-depth*          var           test-is            The maximum depth of stack traces to print when an...
  safe-get                     function      map-utils          Like get, but throws an exception if the key is no...
  safe-get-in                  function      map-utils          Like get-in, but throws an exception if any key is...
  sample                       function      probabilities.monte-carlo Return the distribution of samples of lengt...
@@ -618,6 +641,7 @@ Shortcuts:

  set-rollback-only            function      sql                Marks the outermost transaction such that it will ...
  set-state                    function      monads             Return a state-monad function that replaces the cu...
  set-system-properties        function      java-utils         Set some system properties. Nil clears a property..
+ set-test                     macro         test-is            Experimental. Sets :test metadata of the named var...
  set-val                      function      monads             Return a state-monad function that assumes the sta...
  sgn                          multimethod   generic.math-functions Return the sign of x (-1, 0, or 1)..
  sh                           function      shell-out          Passes the given str