orchard.info
Retrieve the info map from var and symbols.
Retrieve the info map from var and symbols.
file-pathclj
(file-path x)For a file path, return a URL to the file if it exists and does not represent a form evaluated at the REPL.
For a file path, return a URL to the file if it exists and does not represent a form evaluated at the REPL.
infoclj
(info ns sym)(info ns sym params)Provide the info map for the input ns and sym.
The default dialect is :clj but it can be specified as part of params.
Note that the :cljs dialect requires the compiler state to be passed in as :env key in params.
Provide the info map for the input ns and sym. The default dialect is :clj but it can be specified as part of params. Note that the :cljs dialect requires the compiler state to be passed in as :env key in params.
info*clj
(info* params)Provide the info map for the input :ns and :sym.
The default :dialect is :clj but it can be specified as part of params.
Note that the :cljs dialect requires the compiler state to be passed
in as :env key in params.
A :var-meta-allowlist can be optionally passed
(defaults to orchard.meta/var-meta-allowlist;
only applies to :clj since for :cljs there's no allowlisting).
Provide the info map for the input `:ns` and `:sym`. The default `:dialect` is `:clj` but it can be specified as part of `params`. Note that the `:cljs` dialect requires the compiler state to be passed in as `:env` key in params. A `:var-meta-allowlist` can be optionally passed (defaults to `orchard.meta/var-meta-allowlist`; only applies to `:clj` since for `:cljs` there's no allowlisting).
javadoc-infoclj
(javadoc-info path)Resolve a relative javadoc path to a URL and return as a map. Prefer javadoc resources on the classpath; then use online javadoc content for core API classes. If no source is available, return the relative path as is.
Resolve a relative javadoc path to a URL and return as a map. Prefer javadoc resources on the classpath; then use online javadoc content for core API classes. If no source is available, return the relative path as is.
normalize-paramsclj
(normalize-params params)Normalize the info params.
If :sym is unqualified we assoc a :qualified-sym key with it. The namespace used is :ns first and then :context-ns.
If :sym is already qualified with assoc a :computed-ns key and :unqualified-sym key.
If :dialect is nil, we assoc :clj, our default.
Normalize the info params. If :sym is unqualified we assoc a :qualified-sym key with it. The namespace used is :ns first and then :context-ns. If :sym is already qualified with assoc a :computed-ns key and :unqualified-sym key. If :dialect is nil, we assoc :clj, our default.
qualify-symclj
(qualify-sym ns sym)Qualify a symbol, if any in sym, with ns.
Return nil if sym is nil, attempting to generate a valid symbol even
in case some ns is missing.
Qualify a symbol, if any in `sym`, with `ns`. Return nil if `sym` is nil, attempting to generate a valid symbol even in case some `ns` is missing.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close