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.eldoc

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

Some helper functions to support eldoc-like functionality
in editors.
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.java.classpath

Classpath access and modification utilities.

Provides an alternative to the java.classpath contrib library. The library is Boot-aware, meaning it takes into account the classpath manipulation magic, performed by the Boot build tool.

Classpath access and modification utilities.

Provides an alternative to the java.classpath contrib library.
The library is Boot-aware, meaning it takes into account the
classpath manipulation magic, performed by the Boot build tool.
raw docstring

orchard.java.parser

Source and docstring info for Java classes and members.

Parses :docs using Markdown.

This ns is automatically discarded if orchard.java.parser-next can be loaded.

Source and docstring info for Java classes and members.

Parses `:doc`s using Markdown.

This ns is automatically discarded if `orchard.java.parser-next` can be loaded.
raw docstring

orchard.java.parser-next

Source and docstring info for Java classes and members.

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.

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.parser-utils

The common parts to the parser and parser-next namespaces.

The common parts to the `parser` and `parser-next` namespaces.
raw docstring

orchard.java.resource

Resolve JVM resource-related information.

Resolve JVM resource-related information.
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.query

Query for namespaces and vars

Query for namespaces and vars
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 is a website building & hosting documentation for Clojure/Script libraries

× close