orchard.java.parser-next — cider/orchard 0.23.3

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.

cleanup-whitespace clj

(cleanup-whitespace fragments)

coalesce clj

(coalesce xs)

dispatch clj

(dispatch node _stack _found-closing-tags-types)

docstring clj

(docstring e env)

Get parsed docstring text of e using source information in env

lock clj

nbsp clj

newline-fragment clj

A newline intended to separate html fragments. We choose text, because inserting <p> elements could unbalance the tags, given that javadocs don't necessarily consistently choose self-closing tags.

node-reducer clj

(node-reducer {:keys [stack result found-closing-tags-types] :as m} node)

node-reducer-init clj

parse-executable-element clj

(parse-executable-element m env)

parse-info clj

(parse-info o env)

Parsed clj protocol

parse-info* clj

(parse-info* o env)

process-node clj multimethod

remove-left-margin clj

(remove-left-margin s)

source-info clj

(source-info klass & [throw?])

If the source for the Java class is available on the classpath, parse it and return info to supplement reflection. Specifically, this includes source file and position, docstring, and argument name info. Info returned has the same structure as that of orchard.java/reflect-info.