Provides the parsing facilities for Marginalia.
Provides the parsing facilities for Marginalia.
(adjacent? f s)
(arrange-in-sections parsed-code raw-code)
(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? filepath)
(cljx-file? filepath)
(code? o)
(comment? o)
(comments-enabled?)
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 docsMarginalia 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-inner-form form raw nspace-sym)
(extract-docstring m raw nspace-sym)
(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-docstring nspace-sym sym)
(merge-comments f s)
(parse source-string)
(parse* reader)
(parse-file fn)
(parse-ns file)
(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-comment reader semicolon)
(read-comment reader semicolon opts pending)
(read-keyword reader colon)
(read-keyword reader colon opts pending)
(set-comment-reader reader)
(set-keyword-reader reader)
(skip-spaces-and-comments rdr)
(strip-docstring docstring raw)
(with-readers-for file & body)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close