- *comments*
- *comments-enabled*
- *delete-lifted-comments*
- *lift-inline-comments*
- adjacent?
- arrange-in-sections
- call-method
- cljs-file?
- cljx-data-readers
- cljx-file?
- code?
- comment?
- comments-enabled?
- directives
- dispatch-form
- dispatch-inner-form
- extract-docstring
- get-field
- get-var-docstring
- merge-comments
- parse
- parse*
- parse-file
- parse-ns
- process-directive!
- read-comment
- read-keyword
- set-comment-reader
- set-keyword-reader
- skip-spaces-and-comments
- strip-docstring
- sub-level-comments
- top-level-comments
- with-readers-for
marginalia.parser
Provides the parsing facilities for Marginalia.
Provides the parsing facilities for Marginalia.
*comments*clj
*comments-enabled*clj
*delete-lifted-comments*clj
*lift-inline-comments*clj
adjacent?clj
(adjacent? f s)arrange-in-sectionsclj
(arrange-in-sections parsed-code raw-code)call-methodclj
(call-method klass method-name params obj & args)Calls a private or protected method.
params is a vector of classes which correspond to the arguments to the method e
obj is nil for static methods, the instance object otherwise.
The method-name is given a symbol or a keyword (something Named).
Calls a private or protected method. params is a vector of classes which correspond to the arguments to the method e obj is nil for static methods, the instance object otherwise. The method-name is given a symbol or a keyword (something Named).
cljs-file?clj
(cljs-file? filepath)cljx-data-readersclj
cljx-file?clj
(cljx-file? filepath)code?clj
(code? o)comment?clj
(comment? o)comments-enabled?clj
(comments-enabled?)directivesclj
Marginalia can be given directives in comments. A directive is a comment
line containing a directive name, in the form ;; @DirectiveName.
Directives change the behavior of the parser within the files that contain
them.
The following directives are defined:
@MargDisablesuppresses subsequent comments from the docs@MargEnableincludes subsequent comments in the docs
Marginalia can be given directives in comments. A directive is a comment line containing a directive name, in the form `;; @DirectiveName`. Directives change the behavior of the parser within the files that contain them. The following directives are defined: * `@MargDisable` suppresses subsequent comments from the docs * `@MargEnable` includes subsequent comments in the docs
dispatch-formcljmultimethod
dispatch-inner-formclj
(dispatch-inner-form form raw nspace-sym)extract-docstringclj
(extract-docstring m raw nspace-sym)get-fieldclj
(get-field klass field-name obj)Access to private or protected field. field-name is a symbol or keyword.
Access to private or protected field. field-name is a symbol or keyword.
get-var-docstringclj
(get-var-docstring nspace-sym sym)merge-commentsclj
(merge-comments f s)parseclj
(parse source-string)parse*clj
(parse* reader)parse-fileclj
(parse-file fn)parse-nsclj
(parse-ns file)process-directive!clj
(process-directive! line)If the given line is a directive, applies it. Returns a value indicating whether the line should be included in the comments list.
If the given line is a directive, applies it. Returns a value indicating whether the line should be included in the comments list.
read-commentclj
(read-comment reader semicolon)(read-comment reader semicolon opts pending)read-keywordclj
(read-keyword reader colon)(read-keyword reader colon opts pending)set-comment-readerclj
(set-comment-reader reader)set-keyword-readerclj
(set-keyword-reader reader)skip-spaces-and-commentsclj
(skip-spaces-and-comments rdr)strip-docstringclj
(strip-docstring docstring raw)sub-level-commentsclj
top-level-commentsclj
with-readers-forcljmacro
(with-readers-for file & body)cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close