File: cider-doc.el.html

Mode for formatting and presenting documentation

Defined variables (14)

cider-doc-auto-select-bufferControl whether to auto-select the doc popup buffer.
cider-doc-clojuredocs-max-examplesMaximum number of ClojureDocs examples to show inline in the doc buffer.
cider-doc-easy-menuCIDER documentation submenu (for the menu bar).
cider-doc-mapCIDER documentation keymap.
cider-doc-show-clojuredocs-examplesWhether to show ClojureDocs examples in the doc buffer automatically.
cider-docview--clojuredocs-begMarker at the start of the ClojureDocs footer in the doc buffer.
cider-docview--clojuredocs-dataCached ClojureDocs lookup result for the doc buffer’s symbol.
cider-docview--clojuredocs-shownWhether the ClojureDocs examples are currently expanded in the doc buffer.
cider-docview-code-background-colorBackground color for code blocks.
cider-docview-mode-abbrev-tableAbbrev table for ‘cider-docview-mode’.
cider-docview-mode-hookHook run after entering ‘cider-docview-mode’.
cider-docview-mode-mapKeymap for ‘cider-docview-mode’.
cider-docview-mode-menuMenu for CIDER’s doc mode
cider-docview-mode-syntax-tableSyntax table for ‘cider-docview-mode’.

Defined functions (37)

cider--abbreviate-file-protocol(FILE-WITH-PROTOCOL)
cider--docview-adapt-to-theme(&rest _)
cider-create-compact-doc-buffer(SYMBOL)
cider-create-doc-buffer(SYMBOL &optional COMPACT)
cider-doc(&optional ARG)
cider-doc--apropos-args(ARGS)
cider-doc--read-apropos-ns(PROMPT INITIAL-INPUT HISTORY)
cider-doc-apropos(ARG1 &optional ARG2)
cider-doc-apropos-select(ARG1 &optional ARG2)
cider-doc-lookup(SYMBOL)
cider-doc-menu()
cider-docview--fetch-clojuredocs-examples()
cider-docview--insert-clojuredocs-examples(DICT)
cider-docview--insert-clojuredocs-toggle(LABEL)
cider-docview--refresh-clojuredocs-footer()
cider-docview--setup-clojuredocs-footer(INFO)
cider-docview-clojuredocs()
cider-docview-clojuredocs-examples()
cider-docview-clojuredocs-web()
cider-docview-fontify-code-blocks(BUFFER MODE)
cider-docview-fontify-emphasis(BUFFER)
cider-docview-fontify-literals(BUFFER)
cider-docview-format-tables(BUFFER)
cider-docview-javadoc()
cider-docview-mode()
cider-docview-mode-menu(ARG1)
cider-docview-render(BUFFER SYMBOL INFO &optional COMPACT FOR-TOOLTIP)
cider-docview-render-info(BUFFER INFO &optional COMPACT FOR-TOOLTIP)
cider-docview-render-java-doc(BUFFER TEXT)
cider-docview-source()
cider-docview-wrap-text(BUFFER)
cider-javadoc(ARG)
cider-javadoc-handler(SYMBOL-NAME)
transient:cider-doc-menu:--case-sensitive()
transient:cider-doc-menu:--docs()
transient:cider-doc-menu:--ns=()
transient:cider-doc-menu:--private()

Defined faces (4)

cider-docview-emphasis-faceFace for emphasized text.
cider-docview-literal-faceFace for literal text.
cider-docview-strong-faceFace for strongly emphasized text.
cider-docview-table-border-faceFace for table borders.