summaryrefslogtreecommitdiff
path: root/lisp/progmodes/xref.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2022-04-17 12:17:30 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2022-04-17 12:17:30 +0200
commit4d60d9face04bbbd22b4ecf69db208165b670b4f (patch)
tree164df4d322b163d268598672872ad90f3054b58c /lisp/progmodes/xref.el
parentd951e9e650aed1fbe9a587282a8614a4a3b9d35b (diff)
downloademacs-4d60d9face04bbbd22b4ecf69db208165b670b4f.tar.gz
emacs-4d60d9face04bbbd22b4ecf69db208165b670b4f.tar.bz2
emacs-4d60d9face04bbbd22b4ecf69db208165b670b4f.zip
Add a doc string to xref-current-item
* lisp/progmodes/xref.el (xref-after-jump-hook): Link to it. (xref-current-item): Add a doc string to the now-public variable.
Diffstat (limited to 'lisp/progmodes/xref.el')
-rw-r--r--lisp/progmodes/xref.el7
1 files changed, 5 insertions, 2 deletions
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el
index 277934c08a2..958d4e8b9d7 100644
--- a/lisp/progmodes/xref.el
+++ b/lisp/progmodes/xref.el
@@ -381,7 +381,8 @@ elements is negated: these commands will NOT prompt."
(defcustom xref-after-jump-hook '(recenter
xref-pulse-momentarily)
- "Functions called after jumping to an xref."
+ "Functions called after jumping to an xref.
+Also see `xref-current-item'."
:type 'hook)
(defcustom xref-after-return-hook '(xref-pulse-momentarily)
@@ -490,7 +491,9 @@ To undo, use \\[xref-go-forward]."
'xref-current-item
"29.1")
-(defvar xref-current-item nil)
+(defvar xref-current-item nil
+ "Dynamically bound to the current item being processed.
+This can be used from `xref-after-jump-hook', for instance.")
(defun xref-pulse-momentarily ()
(pcase-let ((`(,beg . ,end)