Function: xref-match-item-summary

xref-match-item-summary is a byte-compiled function defined in xref.el.gz.

Signature

(xref-match-item-summary xref-match-item-summary X)

Documentation

Access slot "summary" of xref-match-item struct X.

String which describes the identifier.

When xref-location-line returns non-nil (a number), the summary is implied to be the contents of a file or buffer line containing the identifier. When multiple identifiers in a row report the same line, in the same group (corresponding to the case of multiple identifiers on thesame line), the summaries are concatenated in the Xref output buffer. Consequently, any code that creates xref values should take care to slice the summary values when several identifiers reside on the same line.

This behavior is new in Emacs 28.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/xref.el.gz
(xref--defstruct (xref-match-item
                  (:include xref-item)
                  (:constructor xref-make-match (summary location length))
                  (:noinline t))
  "A match xref item describes a search result."
  length)