Function: shortdoc--insert-group-in-buffer

shortdoc--insert-group-in-buffer is a byte-compiled function defined in shortdoc.el.gz.

Signature

(shortdoc--insert-group-in-buffer GROUP &optional BUF)

Documentation

Insert a short documentation summary for functions in GROUP in buffer BUF.

BUF defaults to the current buffer if nil or omitted.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/shortdoc.el.gz
(defun shortdoc--insert-group-in-buffer (group &optional buf)
  "Insert a short documentation summary for functions in GROUP in buffer BUF.
BUF defaults to the current buffer if nil or omitted."
  (with-current-buffer (or buf (current-buffer))
    (let ((inhibit-read-only t)
          (prev nil))
      (erase-buffer)
      (shortdoc-mode)
      (button-mode)
      (mapc
       (lambda (data)
         (cond
          ((stringp data)
           (setq prev nil)
           (unless (bobp)
             (insert "\n"))
           (insert (propertize
                    (substitute-command-keys data)
                    'face 'shortdoc-heading
                    'shortdoc-section t
                    'outline-level 1))
           (insert (propertize
                    "\n\n"
                    'face 'shortdoc-heading
                    'shortdoc-section t)))
          ;; There may be functions not yet defined in the data.
          ((fboundp (car data))
           (when prev
             (insert (make-separator-line)
                     ;; This helps with hidden outlines (bug#53981)
                     (propertize "\n" 'face '(:height 0))))
           (setq prev t)
           (shortdoc--display-function data))))
       (cdr (assq group shortdoc--groups))))))