API for walton.core

by Unknown

Usage:
(ns your-namespace
  (:require walton.core))

Overview



Public Variables and Functions



add-sexp

function
Usage: (add-sexp sexp)
Adds sexps to a ref after trying them in an explicit in a try/catch.


all-expressions

function
Usage: (all-expressions files)
Collects all sexps in all files into a single sequence.


background-update-walton

function
Usage: (background-update-walton)
Categorizes all of the sexps in the background so you can search immediately.


categorize-all

function
Usage: (categorize-all)
Categorizes all expressions.


categorize-sexps

function
Usage: (categorize-sexps sexps cats)
       (categorize-sexps sexps)
Runs the expressions in a try/catch and categorizes them as :good or :bad.


collect-expressions-in-file

function
Usage: (collect-expressions-in-file file)
Collects all sexps in a single file.


extract-expressions

function
Usage: (extract-expressions string)
Extracts sexps.


extract-working-code

function
Usage: (extract-working-code text files)
Extract working code by running the code text in a try/catch.


find-lines

function
Usage: (find-lines text files)
Search for the string [text] in [files], where files is the result of file-seq.


find-lines-in-file

function
Usage: (find-lines-in-file text file)
Opens a file and extracts the relevant lines from it.


update-walton

function
Usage: (update-walton)
Categorizes all of the sexps up front.


walton

function
Usage: (walton s)
Returns a single random result where the the length of code, and the length of result are both limited to 497 characters each: [code, result].


walton*

function
Usage: (walton* s t m?)
A more flexible version of walton which allows you to specify [s]:a string to search for, [t]:the number of characters to truncate at, [m?]:the number of docs you'd like as output, and [f]:if true, will filter bad results, if false, will show both good and bad results -- true by default.


walton-doc

function
Usage: (walton-doc s)
Returns a sequence of all sexps with the tag :good which match the input string.  If no :good sexps are found, it returns the sexps which are tagged as :bad.


walton-html

function
Usage: (walton-html text)
Outputs the walton-doc results in HTML format for moustache, wrapped in a ring response handler.


walton-html*

function
Usage: (walton-html* text)
Takes a string and then searches for all working expressions and outputs them as an html file into project-root/walton-docs/[text].html.  If there are no working results for the string, it will output the non-working examples which were found for [text].
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.