aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephen Leake2015-11-14 16:44:58 -0600
committerStephen Leake2015-11-15 13:44:41 -0600
commita6843cce90b5041adc456815ca0f7a3fdda6db1f (patch)
tree24da50ff37feed1b2ff3e20ae6674853629c0dfa
parentae16894d1e19601e19b1e70461dc0f69ae1f1059 (diff)
downloademacs-a6843cce90b5041adc456815ca0f7a3fdda6db1f.tar.gz
emacs-a6843cce90b5041adc456815ca0f7a3fdda6db1f.zip
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.
-rw-r--r--lisp/cedet/cedet-global.el3
-rw-r--r--lisp/cedet/ede/locate.el10
-rw-r--r--lisp/cedet/semantic/symref.el2
-rw-r--r--lisp/progmodes/elisp-mode.el1
-rw-r--r--src/fns.c3
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."
104 104
105(defun cedet-gnu-global-expand-filename (filename) 105(defun cedet-gnu-global-expand-filename (filename)
106 "Expand the FILENAME with GNU Global. 106 "Expand the FILENAME with GNU Global.
107Return a fully qualified filename." 107Return a list of absolute filenames or nil if none found.
108Signal an error if Gnu global not available."
108 (interactive "sFile: ") 109 (interactive "sFile: ")
109 (let ((ans (with-current-buffer (cedet-gnu-global-call (list "-Pa" filename)) 110 (let ((ans (with-current-buffer (cedet-gnu-global-call (list "-Pa" filename))
110 (goto-char (point-min)) 111 (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'."
100(defclass ede-locate-base () 100(defclass ede-locate-base ()
101 ((root :initarg :root 101 ((root :initarg :root
102 :documentation 102 :documentation
103 "The root of these locat searches.") 103 "The root of these locate searches.")
104 (file :documentation 104 (file :documentation
105 "The last file search for with EDE locate.") 105 "The last file searched for with EDE locate.")
106 (lastanswer :documentation 106 (lastanswer :documentation
107 "The last answer provided by the locator.") 107 "The last answer provided by the locator.")
108 (hash :documentation 108 (hash :documentation
@@ -245,10 +245,8 @@ variable `cedet-global-command'.")
245 newroot)) 245 newroot))
246 246
247(cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-global) 247(cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-global)
248 filesubstring) 248 filesubstring)
249 "Locate with LOC occurrences of FILESUBSTRING under PROJECTROOT. 249 "Locate occurrences of FILESUBSTRING in LOC, using Gnu Global."
250Searches are done under the current root of the EDE project
251that created this EDE locate object."
252 (require 'cedet-global) 250 (require 'cedet-global)
253 (let ((default-directory (oref loc root))) 251 (let ((default-directory (oref loc root)))
254 (cedet-gnu-global-expand-filename filesubstring))) 252 (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.")
101 101
102(defun semantic-symref-calculate-rootdir () 102(defun semantic-symref-calculate-rootdir ()
103 "Calculate the root directory for a symref search. 103 "Calculate the root directory for a symref search.
104Start with and EDE project, or use the default directory." 104Start with an EDE project, or use the default directory."
105 (let* ((rootproj (when (and (featurep 'ede) ede-minor-mode) 105 (let* ((rootproj (when (and (featurep 'ede) ede-minor-mode)
106 (ede-toplevel))) 106 (ede-toplevel)))
107 (rootdirbase (if rootproj 107 (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
645 ;; alphabetical by result type symbol 645 ;; alphabetical by result type symbol
646 646
647 ;; FIXME: advised function; list of advice functions 647 ;; FIXME: advised function; list of advice functions
648 ;; FIXME: aliased variable
648 649
649 ;; Coding system symbols do not appear in ‘load-history’, 650 ;; Coding system symbols do not appear in ‘load-history’,
650 ;; so we can’t get a location for them. 651 ;; 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
1580list. 1580list.
1581 1581
1582Write `(setq foo (delq element foo))' to be sure of correctly changing 1582Write `(setq foo (delq element foo))' to be sure of correctly changing
1583the value of a list `foo'. */) 1583the value of a list `foo'. See also `remq', which does not modify the
1584argument. */)
1584 (register Lisp_Object elt, Lisp_Object list) 1585 (register Lisp_Object elt, Lisp_Object list)
1585{ 1586{
1586 Lisp_Object tail, tortoise, prev = Qnil; 1587 Lisp_Object tail, tortoise, prev = Qnil;