Commit a6843cce authored by Stephen Leake's avatar Stephen Leake
Browse files

Improve a few doc strings, comments

* lisp/cedet/cedet-global.el (cedet-gnu-global-expand-filename):
* lisp/cedet/ede/locate.el (ede-locate-base):
* lisp/cedet/semantic/symref.el (semantic-symref-calculate-rootdir):
* src/fns.c (Fdelq): Improve doc string.

* lisp/progmodes/elisp-mode.el (elisp--xref-find-definitions): Add FIXME.
parent ae16894d
......@@ -104,7 +104,8 @@ SCOPE is the scope of the search, such as 'project or 'subdirs."
(defun cedet-gnu-global-expand-filename (filename)
"Expand the FILENAME with GNU Global.
Return a fully qualified filename."
Return a list of absolute filenames or nil if none found.
Signal an error if Gnu global not available."
(interactive "sFile: ")
(let ((ans (with-current-buffer (cedet-gnu-global-call (list "-Pa" filename))
(goto-char (point-min))
......
......@@ -100,9 +100,9 @@ based on `ede-locate-setup-options'."
(defclass ede-locate-base ()
((root :initarg :root
:documentation
"The root of these locat searches.")
"The root of these locate searches.")
(file :documentation
"The last file search for with EDE locate.")
"The last file searched for with EDE locate.")
(lastanswer :documentation
"The last answer provided by the locator.")
(hash :documentation
......@@ -245,10 +245,8 @@ variable `cedet-global-command'.")
newroot))
(cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-global)
filesubstring)
"Locate with LOC occurrences of FILESUBSTRING under PROJECTROOT.
Searches are done under the current root of the EDE project
that created this EDE locate object."
filesubstring)
"Locate occurrences of FILESUBSTRING in LOC, using Gnu Global."
(require 'cedet-global)
(let ((default-directory (oref loc root)))
(cedet-gnu-global-expand-filename filesubstring)))
......
......@@ -101,7 +101,7 @@ If no tools are supported, then 'grep is assumed.")
(defun semantic-symref-calculate-rootdir ()
"Calculate the root directory for a symref search.
Start with and EDE project, or use the default directory."
Start with an EDE project, or use the default directory."
(let* ((rootproj (when (and (featurep 'ede) ede-minor-mode)
(ede-toplevel)))
(rootdirbase (if rootproj
......
......@@ -645,6 +645,7 @@ non-nil result supercedes the xrefs produced by
;; alphabetical by result type symbol
;; FIXME: advised function; list of advice functions
;; FIXME: aliased variable
;; Coding system symbols do not appear in ‘load-history’,
;; so we can’t get a location for them.
......
......@@ -1580,7 +1580,8 @@ sublist by modifying its list structure, then returns the resulting
list.
Write `(setq foo (delq element foo))' to be sure of correctly changing
the value of a list `foo'. */)
the value of a list `foo'. See also `remq', which does not modify the
argument. */)
(register Lisp_Object elt, Lisp_Object list)
{
Lisp_Object tail, tortoise, prev = Qnil;
......
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