Function: cider--doc-make-xrefs

cider--doc-make-xrefs is an interactive and byte-compiled function defined in cider-util.el.

Signature

(cider--doc-make-xrefs)

Documentation

Parse and hyperlink documentation cross-references in current buffer.

Find cross-reference information in a buffer and activate such cross references for selection with help-xref. Cross-references are parsed using cider--find-symbol-xref.

Special references back and forward are made to go back and forth through a stack of help buffers. Variables help-back-label and help-forward-label specify the text for that.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/cider-20260414.1619/cider-util.el
;; Similar to https://github.com/emacs-mirror/emacs/blob/65c8c7cb96c14f9c6accd03cc8851b5a3459049e/lisp/help-mode.el#L404
(defun cider--doc-make-xrefs ()
  "Parse and hyperlink documentation cross-references in current buffer.
Find cross-reference information in a buffer and activate such cross
references for selection with `help-xref'.  Cross-references are parsed
using `cider--find-symbol-xref'.

Special references `back' and `forward' are made to go back and forth
through a stack of help buffers.  Variables `help-back-label' and
`help-forward-label' specify the text for that."
  (interactive "b")

  ;; parse the docstring and create xrefs for symbols
  (save-excursion
    (goto-char (point-min))
    (let ((symbol))
      (while (setq symbol (cider--find-symbol-xref))
        (replace-match "")
        (insert-text-button symbol
                            'type 'help-xref
                            'help-function (apply-partially #'cider-doc-lookup
                                                            (cider--eldoc-remove-dot symbol))))))
  (cider--make-back-forward-xrefs))