diff options
| author | Dmitry Gutov | 2019-12-28 20:07:25 +0300 |
|---|---|---|
| committer | Dmitry Gutov | 2019-12-29 15:46:44 +0300 |
| commit | c190e91a1ecf3cbb5d7ff0a149d57dbf32f83974 (patch) | |
| tree | d04f7bfa1548926f44c8acaa36922c2ba8e250b1 | |
| parent | 012c12a05e04ce0efefb41d4fd3a5be72293ee17 (diff) | |
| download | emacs-c190e91a1ecf3cbb5d7ff0a149d57dbf32f83974.tar.gz emacs-c190e91a1ecf3cbb5d7ff0a149d57dbf32f83974.zip | |
Improve docstrings
* lisp/progmodes/xref.el (xref-collect-matches)
(xref-collect-references): Improve docstrings.
| -rw-r--r-- | lisp/progmodes/xref.el | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index 5601cb32b4d..9c806d70ce4 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el | |||
| @@ -1130,7 +1130,9 @@ and just use etags." | |||
| 1130 | (defvar ede-minor-mode) ;; ede.el | 1130 | (defvar ede-minor-mode) ;; ede.el |
| 1131 | 1131 | ||
| 1132 | (defun xref-collect-references (symbol dir) | 1132 | (defun xref-collect-references (symbol dir) |
| 1133 | "Collect references to SYMBOL inside DIR. | 1133 | "Find all references to SYMBOL in directory DIR. |
| 1134 | Return a list of xref values. | ||
| 1135 | |||
| 1134 | This function uses the Semantic Symbol Reference API, see | 1136 | This function uses the Semantic Symbol Reference API, see |
| 1135 | `semantic-symref-tool-alist' for details on which tools are used, | 1137 | `semantic-symref-tool-alist' for details on which tools are used, |
| 1136 | and when." | 1138 | and when." |
| @@ -1160,7 +1162,8 @@ and when." | |||
| 1160 | 1162 | ||
| 1161 | ;;;###autoload | 1163 | ;;;###autoload |
| 1162 | (defun xref-collect-matches (regexp files dir ignores) | 1164 | (defun xref-collect-matches (regexp files dir ignores) |
| 1163 | "Collect matches for REGEXP inside FILES in DIR. | 1165 | "Find all matches for REGEXP in FILES in directory DIR. |
| 1166 | Return a list of xref values. | ||
| 1164 | FILES is a string with glob patterns separated by spaces. | 1167 | FILES is a string with glob patterns separated by spaces. |
| 1165 | IGNORES is a list of glob patterns." | 1168 | IGNORES is a list of glob patterns." |
| 1166 | ;; DIR can also be a regular file for now; let's not advertise that. | 1169 | ;; DIR can also be a regular file for now; let's not advertise that. |