Liking cljdoc? Tell your friends :D

marginalia.parser

Provides the parsing facilities for Marginalia.

Provides the parsing facilities for Marginalia.
raw docstring

*comments*clj

source

*comments-enabled*clj

source

adjacent?clj

(adjacent? f s)
source

arrange-in-sectionsclj

(arrange-in-sections parsed-code raw-code)
source

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).
sourceraw docstring

cljs-file?clj

(cljs-file? filepath)
source

cljx-data-readersclj

source

cljx-file?clj

(cljx-file? filepath)
source

code?clj

(code? o)
source

comment?clj

(comment? o)
source

comments-enabled?clj

(comments-enabled?)
source

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:

  • @MargDisable suppresses subsequent comments from the docs
  • @MargEnable includes 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
sourceraw docstring

dispatch-formcljmultimethod

source

dispatch-inner-formclj

(dispatch-inner-form form raw nspace-sym)
source

extract-docstringclj

(extract-docstring m raw nspace-sym)
source

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.
sourceraw docstring

get-var-docstringclj

(get-var-docstring nspace-sym sym)
source

merge-commentsclj

(merge-comments f s)
source

parseclj

(parse source-string)
source

parse*clj

(parse* reader)
source

parse-fileclj

(parse-file fn)
source

parse-nsclj

(parse-ns file)
source

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.
sourceraw docstring

read-commentclj

(read-comment reader semicolon)
(read-comment reader semicolon opts pending)
source

read-keywordclj

(read-keyword reader colon)
(read-keyword reader colon opts pending)
source

set-comment-readerclj

(set-comment-reader reader)
source

set-keyword-readerclj

(set-keyword-reader reader)
source

skip-spaces-and-commentsclj

(skip-spaces-and-comments rdr)
source

strip-docstringclj

(strip-docstring docstring raw)
source

sub-level-commentsclj

source

top-level-commentsclj

source

with-readers-forcljmacro

(with-readers-for file & body)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close