API for gen-html-docs - clojure-contrib v1.2 (stable)

by Craig Andera

clojure-contrib is now deprecated

clojure-contrib is no longer being developed or maintained.

Rather than a single, monolithic, contributions library, Clojure now has a set of separate libraries for each unit of functionality. The libraries are in the Clojure GitHub organization at https://github.com/clojure. API documentation of the libraries can be found at http://clojure.github.io.

If you're looking for a specific function or namespace from the old clojure-contrib, see "Where Did Clojure.Contrib Go".


Full namespace name: clojure.contrib.gen-html-docs

Overview

Generates a single HTML page that contains the documentation for
one or more Clojure libraries.

Public Variables and Functions



generate-documentation

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (generate-documentation libs)
Returns a string which is the HTML documentation for the libraries
named by libs. Libs is a vector of symbols identifying Clojure
libraries.
Source


generate-documentation-to-file

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (generate-documentation-to-file path libs)
Calls generate-documentation on the libraries named by libs and
emits the generated HTML to the path named by path.
Source
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.