API for clojure.java.javadoc - Clojure v1.10.3 (legacy)

by Christophe Grand, Stuart Sierra

Full namespace name: clojure.java.javadoc

Overview

A repl helper to quickly open javadocs.

Public Variables and Functions



add-local-javadoc

function
Usage: (add-local-javadoc path)
Adds to the list of local Javadoc paths.

    Added in Clojure version 1.2
Source


add-remote-javadoc

function
Usage: (add-remote-javadoc package-prefix url)
Adds to the list of remote Javadoc URLs.  package-prefix is the
beginning of the package name that has docs at this URL.

    Added in Clojure version 1.2
Source


javadoc

function
Usage: (javadoc class-or-object)
Opens a browser window displaying the javadoc for the argument.
Tries *local-javadocs* first, then *remote-javadocs*.

    Added in Clojure version 1.2
Source
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.