Commit c190e91a authored by Dmitry Gutov's avatar Dmitry Gutov
Browse files

Improve docstrings

* lisp/progmodes/xref.el (xref-collect-matches)
(xref-collect-references): Improve docstrings.
parent 012c12a0
...@@ -1130,7 +1130,9 @@ and just use etags." ...@@ -1130,7 +1130,9 @@ and just use etags."
(defvar ede-minor-mode) ;; ede.el (defvar ede-minor-mode) ;; ede.el
(defun xref-collect-references (symbol dir) (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 This function uses the Semantic Symbol Reference API, see
`semantic-symref-tool-alist' for details on which tools are used, `semantic-symref-tool-alist' for details on which tools are used,
and when." and when."
...@@ -1160,7 +1162,8 @@ and when." ...@@ -1160,7 +1162,8 @@ and when."
;;;###autoload ;;;###autoload
(defun xref-collect-matches (regexp files dir ignores) (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. FILES is a string with glob patterns separated by spaces.
IGNORES is a list of glob patterns." IGNORES is a list of glob patterns."
;; DIR can also be a regular file for now; let's not advertise that. ;; DIR can also be a regular file for now; let's not advertise that.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment