code.doc.engine.plugin.api

api-element

added in 3.0

(api-element {:keys [table tag title namespace project display], :or {title "", display #{:tags :entries}}, :as elem})

displays the entire :api namespace

api-entry

added in 3.0

(api-entry [var entry :as pair] {:keys [project namespace], :as elem})

formats a ns/var pair tag into an html element

api-entry-example

added in 3.0

(api-entry-example entry project)

helper function to convert a test entry into a html tree form

api-entry-source

added in 3.0

(api-entry-source entry project var namespace)

helper function to convert a source entry into a html tree form

entry-arglists

added in 4.1

(entry-arglists entry)

formats arglists for api display

entry-status-badges

added in 4.1

(entry-status-badges entry)

creates badges for deprecated or experimental apis

entry-tag

added in 3.0

(entry-tag ns var)

helper for formating vars

(entry-tag ’code.doc ’output-path) = “entry__code.doc__output_path”

lower-first

added in 3.0

(lower-first s)

converts the first letter to lowercase

(lower-first “Hello”) => “hello”

select-entries

added in 3.0

(select-entries {:keys [table class only exclude module], :as elem})

selects api entries based on filters