Function: mode-local--overload-docstring-extension

mode-local--overload-docstring-extension is a byte-compiled function defined in mode-local.el.gz.

Signature

(mode-local--overload-docstring-extension OVERLOAD)

Documentation

Return the doc string that augments the description of OVERLOAD.

Aliases

overload-docstring-extension (obsolete since 27.1)

Source Code

;; Defined in /usr/src/emacs/lisp/cedet/mode-local.el.gz
(defun mode-local--overload-docstring-extension (overload)
  "Return the doc string that augments the description of OVERLOAD."
  (let ((doc "\nThis function can be overloaded\
 with `define-mode-local-override'.")
        (sym (mode-local--overload-obsoleted-by overload)))
    (when sym
      (setq doc (format "%s\nIt has made the overload `%s' obsolete since %s."
                        doc sym
                        (get sym 'mode-local--overload-obsoleted-since))))
    (setq sym (mode-local--overload-that-obsolete overload))
    (when sym
      (setq doc (format
                 "%s\nThis overload is obsolete since %s;\nUse `%s' instead."
                 doc (get overload 'mode-local--overload-obsoleted-since) sym)))
    doc))