Liking cljdoc? Tell your friends :D

orchard.apropos

Search symbols and docs matching a regular expression

Search symbols and docs matching a regular expression
raw docstring

orchard.clojuredocs

Find docs from ClojureDocs and retrieve the result as a map.

Find docs from ClojureDocs and retrieve the result as a map.
raw docstring

orchard.eldoc

Some helper functions to support eldoc-like functionality in editors.

Some helper functions to support eldoc-like functionality
in editors.
raw docstring

orchard.info

Retrieve the info map from var and symbols.

Retrieve the info map from var and symbols.
raw docstring

orchard.inspect

Clojure data structure inspection functionality. This code has a long history and at various points of time it lived in different projects. Originally it was part of swank-clojure, afterwards it was moved to javert, then forked to another project from which it was contributed to cider-nrepl. Finally cider-nrepl was split into two libraries and the code ended up here.

Pretty wild, right?

Clojure data structure inspection functionality.
This code has a long history and at various points of
time it lived in different projects. Originally
it was part of swank-clojure, afterwards it was moved to
javert, then forked to another project from which it
was contributed to cider-nrepl. Finally cider-nrepl
was split into two libraries and the code ended up here.

Pretty wild, right?
raw docstring

orchard.inspect.analytics

Submodule of Orchard Inspector for getting quick insights about the inspected data. A "Metabase" for Orchard/CIDER Inspector.

Submodule of Orchard Inspector for getting quick insights about the inspected
data. A "Metabase" for Orchard/CIDER Inspector.
raw docstring

orchard.java.classpath

Classpath access and modification utilities.

Provides an alternative to the java.classpath contrib library.

Classpath access and modification utilities.

Provides an alternative to the java.classpath contrib library.
raw docstring

orchard.java.modules

Utilities for accessing module information. Requires JDK11 and onward.

Utilities for accessing module information. Requires JDK11 and onward.
raw docstring

orchard.java.parser-next

Source and docstring info for Java classes and members. Requires JDK11+.

Leaves :doc untouched.

Adds :doc-fragments, :doc-first-sentence-fragments, and :doc-block-tags-fragments attributes. These represent sequences of 'fragments', which can be of text or html type:

  • :doc-fragments represents the body of the comment, including the first sentence and excluding any block tags
  • :doc-first-sentence-fragments represents the first sentence of the doc comment.
  • :doc-block-tags-fragments represent the 'param', 'returns' and 'throws' documentation.

Clients are expected them to render the html fragments using a client-specific method, and then join the client-processed strings into a single string.

Fragments of "html" type may have leading/trailing whitespace, which is to be ignored (since an HTML parser would ignored it anyway).

Fragments of "text" type have significant, carefully processed leading/trailing whitespace such that when joining all fragments, things will look correct without having to add any extra whitespace.

Source and docstring info for Java classes and members. Requires JDK11+.

Leaves `:doc` untouched.

Adds `:doc-fragments`, `:doc-first-sentence-fragments`, and `:doc-block-tags-fragments` attributes.
These represent sequences of 'fragments', which can be of text or html type:

* `:doc-fragments` represents the body of the comment, including the first sentence and excluding any block tags
* `:doc-first-sentence-fragments` represents the first sentence of the doc comment.
* `:doc-block-tags-fragments` represent the 'param', 'returns' and 'throws' documentation.

Clients are expected them to render the html fragments using a client-specific method,
and then join the client-processed strings into a single string.

Fragments of "html" type may have leading/trailing whitespace, which is to be ignored
(since an HTML parser would ignored it anyway).

Fragments of "text" type have significant, carefully processed leading/trailing whitespace
such that when joining all fragments, things will look correct without having to add any extra whitespace.
raw docstring

orchard.java.resource

Resolve JVM resource-related information.

Resolve JVM resource-related information.
raw docstring

orchard.java.source-files

Contains functions for discovering Java source files that are already available on the REPL and for downloading sources from Maven.

Contains functions for discovering Java source files that are already available
on the REPL and for downloading sources from Maven.
raw docstring

orchard.namespace

Utilities for resolving and loading namespaces.

Operations are parallel wherever it makes sense and it's safe to do so; efficiency matters particularly for large projects/classpaths.

Utilities for resolving and loading namespaces.

Operations are parallel wherever it makes sense and it's safe to do so;
efficiency matters particularly for large projects/classpaths.
raw docstring

orchard.pp

A pretty-printer for Clojure data structures. This namespace is borrowed from Eero Helenius' pp project and modified according to Orchard needs. Linear printing parts were replaced with substitutes from orchard.print for reuse and consistency.

Based on the algorithm described in "Pretty-Printing, Converting List to Linear Structure" by Ira Goldstein (Artificial Intelligence, Memo No. 279 in Massachusetts Institute of Technology A.I. Laboratory, February 1973).

A pretty-printer for Clojure data structures. This namespace is borrowed from
Eero Helenius' pp project and modified according to Orchard needs. Linear
printing parts were replaced with substitutes from `orchard.print` for reuse
and consistency.

Based on the algorithm described in "Pretty-Printing, Converting List
to Linear Structure" by Ira Goldstein (Artificial Intelligence, Memo
No. 279 in Massachusetts Institute of Technology A.I. Laboratory,
February 1973).
raw docstring

orchard.print

Custom object printer used by development tooling like Inspector. Similar to Clojure's print-method. Main objectives:

  • honor *print-level* and *print-length* variables
  • provide sufficiently good performance
  • limit the maximum print size and stop printing after it is reached
Custom object printer used by development tooling like Inspector. Similar to
Clojure's `print-method`. Main objectives:

- honor `*print-level*` and `*print-length*` variables
- provide sufficiently good performance
- limit the maximum print size and stop printing after it is reached
raw docstring

orchard.profile

Very simplistic manual tracing profiler for individual functions.

Very simplistic manual tracing profiler for individual functions.
raw docstring

orchard.query

Query for namespaces and vars

Query for namespaces and vars
raw docstring

orchard.stacktrace

Instruments for analyzing exceptions and stacktraces which process exception objects and attach extra data to them.

Instruments for analyzing exceptions and stacktraces which process exception
objects and attach extra data to them.
raw docstring

orchard.trace

Faster and prettier reimplementation of clojure.tools.trace with unnecessary parts removed. Used for tracing function invocations and their results.

Faster and prettier reimplementation of `clojure.tools.trace` with unnecessary
parts removed. Used for tracing function invocations and their results.
raw docstring

orchard.util.io

Utility functions for dealing with file system objects, and in/out streams.

Utility functions for dealing with file system objects, and in/out streams.
raw docstring

orchard.util.os

Operating system specific utilities. This is a port of BaseDirectories.java in soc/directories-jvm. https://github.com/soc/directories-jvm

Operating system specific utilities.
This is a port of BaseDirectories.java in soc/directories-jvm.
https://github.com/soc/directories-jvm
raw docstring

orchard.xref

Utilities for finding function dependencies and references.

Utilities for finding function dependencies and
references.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close