clojure-contrib v1.1 API
Namespaces
Other Versions
Clojure Home

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

by Craig Andera
Usage: 
(ns your-namespace
  (:require 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

  
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

  
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.