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.

diff --git a/lisp/cedet/cedet-global.el b/lisp/cedet/cedet-global.el
index 3ceed5d3b54a067db78ebfc601aae4f3199b2b0b..77ffef037f1416cc882e49bccc48772816597efc 100644 (file)
--- 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 a076c46513ce4b0a0f12a7fdac767045777ffd27..cee2f8ec419dc89899d7fb8e1d4af6ea3eeefc1f 100644 (file)
--- 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 89e8b40632dbb4e272679be9b3b66aeb69e302cf..15070dc0558b5290809e1362d3a9a26454d5bd45 100644 (file)
--- 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 d6e7f83775070a269b84c08b875ef15fc1e9d624..bf0f4b0c9b9bba6f215184048b5b58086513f5d3 100644 (file)
--- 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 46956668777949be1edb1475c642032de5559fd2..efc319e721f2fe4da9f927c2e55c5b8aa20690ae 100644 (file)
--- 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;