[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
emacs-27 c190e91 1/6: Improve docstrings
From: |
Dmitry Gutov |
Subject: |
emacs-27 c190e91 1/6: Improve docstrings |
Date: |
Sun, 29 Dec 2019 07:46:56 -0500 (EST) |
branch: emacs-27
commit c190e91a1ecf3cbb5d7ff0a149d57dbf32f83974
Author: Dmitry Gutov <address@hidden>
Commit: Dmitry Gutov <address@hidden>
Improve docstrings
* lisp/progmodes/xref.el (xref-collect-matches)
(xref-collect-references): Improve docstrings.
---
lisp/progmodes/xref.el | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el
index 5601cb3..9c806d7 100644
--- a/lisp/progmodes/xref.el
+++ b/lisp/progmodes/xref.el
@@ -1130,7 +1130,9 @@ and just use etags."
(defvar ede-minor-mode) ;; ede.el
(defun xref-collect-references (symbol dir)
- "Collect references to SYMBOL inside DIR.
+ "Find all references to SYMBOL in directory DIR.
+Return a list of xref values.
+
This function uses the Semantic Symbol Reference API, see
`semantic-symref-tool-alist' for details on which tools are used,
and when."
@@ -1160,7 +1162,8 @@ and when."
;;;###autoload
(defun xref-collect-matches (regexp files dir ignores)
- "Collect matches for REGEXP inside FILES in DIR.
+ "Find all matches for REGEXP in FILES in directory DIR.
+Return a list of xref values.
FILES is a string with glob patterns separated by spaces.
IGNORES is a list of glob patterns."
;; DIR can also be a regular file for now; let's not advertise that.
- emacs-27 updated (012c12a -> 70fe552), Dmitry Gutov, 2019/12/29
- emacs-27 c190e91 1/6: Improve docstrings,
Dmitry Gutov <=
- emacs-27 70fe552 6/6: ; xref-references-in-directory: Autoload as well, Dmitry Gutov, 2019/12/29
- emacs-27 65af18d 3/6: Rename xref-collect-references and xref-collect-matches, Dmitry Gutov, 2019/12/29
- emacs-27 181f571 5/6: Fix up requires, Dmitry Gutov, 2019/12/29
- emacs-27 98788bf 2/6: ; Improve the docstring some more, Dmitry Gutov, 2019/12/29
- emacs-27 43f66c3 4/6: Extract xref-matches-in-files from project--find-regexp-in-files, Dmitry Gutov, 2019/12/29