From a6843cce90b5041adc456815ca0f7a3fdda6db1f Mon Sep 17 00:00:00 2001 From: Stephen Leake Date: Sat, 14 Nov 2015 16:44:58 -0600 Subject: [PATCH] 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. --- lisp/cedet/cedet-global.el | 3 ++- lisp/cedet/ede/locate.el | 10 ++++------ lisp/cedet/semantic/symref.el | 2 +- lisp/progmodes/elisp-mode.el | 1 + src/fns.c | 3 ++- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/lisp/cedet/cedet-global.el b/lisp/cedet/cedet-global.el index 3ceed5d3b54..77ffef037f1 100644 --- a/lisp/cedet/cedet-global.el +++ b/lisp/cedet/cedet-global.el @@ -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)) diff --git a/lisp/cedet/ede/locate.el b/lisp/cedet/ede/locate.el index a076c46513c..cee2f8ec419 100644 --- a/lisp/cedet/ede/locate.el +++ b/lisp/cedet/ede/locate.el @@ -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))) diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el index 89e8b40632d..15070dc0558 100644 --- a/lisp/cedet/semantic/symref.el +++ b/lisp/cedet/semantic/symref.el @@ -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 diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el index d6e7f837750..bf0f4b0c9b9 100644 --- a/lisp/progmodes/elisp-mode.el +++ b/lisp/progmodes/elisp-mode.el @@ -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. diff --git a/src/fns.c b/src/fns.c index 46956668777..efc319e721f 100644 --- a/src/fns.c +++ b/src/fns.c @@ -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; -- 2.39.5