summaryrefslogtreecommitdiff
path: root/lisp/cedet/semantic
diff options
context:
space:
mode:
authorPaul Eggert <eggert@cs.ucla.edu>2015-11-17 15:28:50 -0800
committerPaul Eggert <eggert@cs.ucla.edu>2015-11-17 15:29:35 -0800
commitac16149ba470ae8a625d42a61adbb6e84254c675 (patch)
tree9575cf0f1c5139a1943f9a18dd444ddc46983aa9 /lisp/cedet/semantic
parentabf673af29ba2a2e0001ebd1db183377724f0cc4 (diff)
downloademacs-ac16149ba470ae8a625d42a61adbb6e84254c675.tar.gz
Fix docstring quoting problems with ‘ '’
Problem reported by Artur Malabarba in: http://lists.gnu.org/archive/html/emacs-devel/2015-11/msg01513.html Most of these fixes are to documentation; many involve fixing longstanding quoting glitches that are independent of the recent substitute-command-keys changes. The changes to code are: * lisp/cedet/mode-local.el (mode-local-augment-function-help) (describe-mode-local-overload): Substitute docstrings before displaying them. * lisp/emacs-lisp/cl-macs.el (cl--transform-lambda): Quote the generated docstring for later substitution.
Diffstat (limited to 'lisp/cedet/semantic')
-rw-r--r--lisp/cedet/semantic/bovine/c.el4
-rw-r--r--lisp/cedet/semantic/db-find.el2
-rw-r--r--lisp/cedet/semantic/doc.el6
-rw-r--r--lisp/cedet/semantic/fw.el2
-rw-r--r--lisp/cedet/semantic/lex.el4
-rw-r--r--lisp/cedet/semantic/sort.el2
-rw-r--r--lisp/cedet/semantic/symref.el12
-rw-r--r--lisp/cedet/semantic/tag.el20
8 files changed, 26 insertions, 26 deletions
diff --git a/lisp/cedet/semantic/bovine/c.el b/lisp/cedet/semantic/bovine/c.el
index 1c25c7b0808..d5af635d14c 100644
--- a/lisp/cedet/semantic/bovine/c.el
+++ b/lisp/cedet/semantic/bovine/c.el
@@ -1513,7 +1513,7 @@ Override function for `semantic-tag-protection'."
(define-mode-local-override semantic-find-tags-included c-mode
(&optional table)
- "Find all tags in TABLE that are of the 'include class.
+ "Find all tags in TABLE that are of the `include' class.
TABLE is a tag table. See `semantic-something-to-tag-table'.
For C++, we also have to search namespaces for include tags."
(let ((tags (semantic-find-tags-by-class 'include table))
@@ -1948,7 +1948,7 @@ For types with a :parent, create faux namespaces to put TAG into."
(define-mode-local-override semanticdb-find-table-for-include c-mode
(includetag &optional table)
"For a single INCLUDETAG found in TABLE, find a `semanticdb-table' object
-INCLUDETAG is a semantic TAG of class 'include.
+INCLUDETAG is a semantic TAG of class `include'.
TABLE is a semanticdb table that identifies where INCLUDETAG came from.
TABLE is optional if INCLUDETAG has an overlay of :filename attribute.
diff --git a/lisp/cedet/semantic/db-find.el b/lisp/cedet/semantic/db-find.el
index 293f535d60b..b441cd18b63 100644
--- a/lisp/cedet/semantic/db-find.el
+++ b/lisp/cedet/semantic/db-find.el
@@ -854,7 +854,7 @@ This makes it appear more like the results of a `semantic-find-' call.
Optional FIND-FILE-MATCH loads all files associated with RESULTS
into buffers. This has the side effect of enabling `semantic-tag-buffer' to
return a value.
-If FIND-FILE-MATCH is 'name, then only the filename is stored
+If FIND-FILE-MATCH is `name', then only the filename is stored
in each tag instead of loading each file into a buffer.
If the input RESULTS are not going to be used again, and if
FIND-FILE-MATCH is nil, you can use `semanticdb-fast-strip-find-results'
diff --git a/lisp/cedet/semantic/doc.el b/lisp/cedet/semantic/doc.el
index 3ceb3510ad2..65718a0532e 100644
--- a/lisp/cedet/semantic/doc.el
+++ b/lisp/cedet/semantic/doc.el
@@ -41,7 +41,7 @@ some documentation in a comment preceding TAG's definition which we
can look for. When appropriate, this can be overridden by a language specific
enhancement.
Optional argument NOSNARF means to only return the lexical analyzer token for it.
-If nosnarf if 'lex, then only return the lex token."
+If NOSNARF is `lex', then only return the lex token."
(if (not tag) (setq tag (semantic-current-tag)))
(save-excursion
(when (semantic-tag-with-position-p tag)
@@ -66,7 +66,7 @@ If nosnarf if 'lex, then only return the lex token."
If TAG is nil. use the tag under point.
Searches the space between TAG and the preceding tag for a comment,
and converts the comment into clean documentation.
-Optional argument NOSNARF with a value of 'lex means to return
+Optional argument NOSNARF with a value of `lex' means to return
just the lexical token and not the string."
(if (not tag) (setq tag (semantic-current-tag)))
(save-excursion
@@ -92,7 +92,7 @@ just the lexical token and not the string."
"Snarf up the comment at POINT for `semantic-documentation-for-tag'.
Attempt to strip out comment syntactic sugar.
Argument NOSNARF means don't modify the found text.
-If NOSNARF is 'lex, then return the lex token."
+If NOSNARF is `lex', then return the lex token."
(let* ((semantic-ignore-comments nil)
(semantic-lex-analyzer #'semantic-comment-lexer))
(if (memq nosnarf '(lex flex)) ;; keep `flex' for compatibility
diff --git a/lisp/cedet/semantic/fw.el b/lisp/cedet/semantic/fw.el
index d8ba6f275f3..b7a6ed352d1 100644
--- a/lisp/cedet/semantic/fw.el
+++ b/lisp/cedet/semantic/fw.el
@@ -193,7 +193,7 @@ Possible Lifespans are:
))
(defun semantic-cache-data-post-command-hook ()
- "Flush `semantic-cache-data-overlays' based 'lifespan property.
+ "Flush `semantic-cache-data-overlays' based `lifespan' property.
Remove self from `post-command-hook' if it is empty."
(let ((newcache nil)
(oldcache semantic-cache-data-overlays))
diff --git a/lisp/cedet/semantic/lex.el b/lisp/cedet/semantic/lex.el
index 7738e06ff88..c8645c2b7d3 100644
--- a/lisp/cedet/semantic/lex.el
+++ b/lisp/cedet/semantic/lex.el
@@ -1815,13 +1815,13 @@ to keep comments as part of the token stream.")
(make-variable-buffer-local 'semantic-ignore-comments)
(defvar semantic-flex-enable-newlines nil
- "When flexing, report 'newlines as syntactic elements.
+ "When flexing, report newlines as syntactic elements.
Useful for languages where the newline is a special case terminator.
Only set this on a per mode basis, not globally.")
(make-variable-buffer-local 'semantic-flex-enable-newlines)
(defvar semantic-flex-enable-whitespace nil
- "When flexing, report 'whitespace as syntactic elements.
+ "When flexing, report whitespace as syntactic elements.
Useful for languages where the syntax is whitespace dependent.
Only set this on a per mode basis, not globally.")
(make-variable-buffer-local 'semantic-flex-enable-whitespace)
diff --git a/lisp/cedet/semantic/sort.el b/lisp/cedet/semantic/sort.el
index 587d084701d..22826635986 100644
--- a/lisp/cedet/semantic/sort.el
+++ b/lisp/cedet/semantic/sort.el
@@ -453,7 +453,7 @@ has some sort of label defining a parent. The parent return will
be a string.
The default behavior, if not overridden with
-`tag-member-parent' gets the 'parent extra
+`tag-member-parent' gets the `parent' extra
specifier of TAG.
If this function is overridden, use
diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el
index 15070dc0558..04684035ac0 100644
--- a/lisp/cedet/semantic/symref.el
+++ b/lisp/cedet/semantic/symref.el
@@ -162,7 +162,7 @@ ARGS are the initialization arguments to pass to the created class."
;;;###autoload
(defun semantic-symref-find-references-by-name (name &optional scope tool-return)
"Find a list of references to NAME in the current project.
-Optional SCOPE specifies which file set to search. Defaults to 'project.
+Optional SCOPE specifies which file set to search. Defaults to `project'.
Refers to `semantic-symref-tool', to determine the reference tool to use
for the current buffer.
Returns an object of class `semantic-symref-result'.
@@ -186,7 +186,7 @@ to perform the search. This was added for use by a test harness."
;;;###autoload
(defun semantic-symref-find-tags-by-name (name &optional scope)
"Find a list of tags by NAME in the current project.
-Optional SCOPE specifies which file set to search. Defaults to 'project.
+Optional SCOPE specifies which file set to search. Defaults to `project'.
Refers to `semantic-symref-tool', to determine the reference tool to use
for the current buffer.
Returns an object of class `semantic-symref-result'."
@@ -206,7 +206,7 @@ Returns an object of class `semantic-symref-result'."
;;;###autoload
(defun semantic-symref-find-tags-by-regexp (name &optional scope)
"Find a list of references to NAME in the current project.
-Optional SCOPE specifies which file set to search. Defaults to 'project.
+Optional SCOPE specifies which file set to search. Defaults to `project'.
Refers to `semantic-symref-tool', to determine the reference tool to use
for the current buffer.
Returns an object of class `semantic-symref-result'."
@@ -226,7 +226,7 @@ Returns an object of class `semantic-symref-result'."
;;;###autoload
(defun semantic-symref-find-tags-by-completion (name &optional scope)
"Find a list of references to NAME in the current project.
-Optional SCOPE specifies which file set to search. Defaults to 'project.
+Optional SCOPE specifies which file set to search. Defaults to `project'.
Refers to `semantic-symref-tool', to determine the reference tool to use
for the current buffer.
Returns an object of class `semantic-symref-result'."
@@ -246,7 +246,7 @@ Returns an object of class `semantic-symref-result'."
;;;###autoload
(defun semantic-symref-find-file-references-by-name (name &optional scope)
"Find a list of references to NAME in the current project.
-Optional SCOPE specifies which file set to search. Defaults to 'project.
+Optional SCOPE specifies which file set to search. Defaults to `project'.
Refers to `semantic-symref-tool', to determine the reference tool to use
for the current buffer.
Returns an object of class `semantic-symref-result'."
@@ -267,7 +267,7 @@ Returns an object of class `semantic-symref-result'."
(defun semantic-symref-find-text (text &optional scope)
"Find a list of occurrences of TEXT in the current project.
TEXT is a regexp formatted for use with egrep.
-Optional SCOPE specifies which file set to search. Defaults to 'project.
+Optional SCOPE specifies which file set to search. Defaults to `project'.
Refers to `semantic-symref-tool', to determine the reference tool to use
for the current buffer.
Returns an object of class `semantic-symref-result'."
diff --git a/lisp/cedet/semantic/tag.el b/lisp/cedet/semantic/tag.el
index 34fc8ba92ce..8ec5fffd413 100644
--- a/lisp/cedet/semantic/tag.el
+++ b/lisp/cedet/semantic/tag.el
@@ -375,7 +375,7 @@ Optional argument IGNORABLE-ATTRIBUTES is passed down to
(defun semantic-tag-of-type-p (tag type)
"Compare TAG's type against TYPE. Non nil if equivalent.
-TYPE can be a string, or a tag of class 'type.
+TYPE can be a string, or a tag of class `type'.
This can be complex since some tags might have a :type that is a tag,
while other tags might just have a string. This function will also be
return true of TAG's type is compared directly to the declaration of a
@@ -462,12 +462,12 @@ pairs eliminated:
"Create a generic semantic tag.
NAME is a string representing the name of this tag.
CLASS is the symbol that represents the class of tag this is,
-such as 'variable, or 'function.
+such as `variable', or `function'.
ATTRIBUTES is a list of additional attributes belonging to this tag."
(list name class (semantic-tag-make-plist attributes) nil nil))
(defsubst semantic-tag-new-variable (name type &optional default-value &rest attributes)
- "Create a semantic tag of class 'variable.
+ "Create a semantic tag of class `variable'.
NAME is the name of this variable.
TYPE is a string or semantic tag representing the type of this variable.
Optional DEFAULT-VALUE is a string representing the default value of this
@@ -479,7 +479,7 @@ tag."
attributes))
(defsubst semantic-tag-new-function (name type arg-list &rest attributes)
- "Create a semantic tag of class 'function.
+ "Create a semantic tag of class `function'.
NAME is the name of this function.
TYPE is a string or semantic tag representing the type of this function.
ARG-LIST is a list of strings or semantic tags representing the
@@ -491,7 +491,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag."
attributes))
(defsubst semantic-tag-new-type (name type members parents &rest attributes)
- "Create a semantic tag of class 'type.
+ "Create a semantic tag of class `type'.
NAME is the name of this type.
TYPE is a string or semantic tag representing the type of this type.
MEMBERS is a list of strings or semantic tags representing the
@@ -516,7 +516,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag."
attributes))
(defsubst semantic-tag-new-include (name system-flag &rest attributes)
- "Create a semantic tag of class 'include.
+ "Create a semantic tag of class `include'.
NAME is the name of this include.
SYSTEM-FLAG represents that we were able to identify this include as belonging
to the system, as opposed to belonging to the local project.
@@ -526,7 +526,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag."
attributes))
(defsubst semantic-tag-new-package (name detail &rest attributes)
- "Create a semantic tag of class 'package.
+ "Create a semantic tag of class `package'.
NAME is the name of this package.
DETAIL is extra information about this package, such as a location where
it can be found.
@@ -536,7 +536,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag."
attributes))
(defsubst semantic-tag-new-code (name detail &rest attributes)
- "Create a semantic tag of class 'code.
+ "Create a semantic tag of class `code'.
NAME is a name for this code.
DETAIL is extra information about the code.
ATTRIBUTES is a list of additional attributes belonging to this tag."
@@ -823,7 +823,7 @@ in SUPERS."
(defun semantic-tag-type-superclass-protection (tag parentstring)
"Return the inheritance protection in TAG from PARENTSTRING.
PARENTSTRING is the name of the parent being inherited.
-The return protection is a symbol, 'public, 'protection, and 'private."
+The return protection is a symbol, `public', `protection', and `private'."
(let ((supers (semantic-tag-get-attribute tag :superclasses)))
(cond ((stringp supers)
'public)
@@ -946,7 +946,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag."
The returned value is a tag of the class that
`semantic-tag-alias-class' returns for TAG.
The default is to return the value of the :definition attribute.
-Return nil if TAG is not of class 'alias."
+Return nil if TAG is not of class `alias'."
(when (semantic-tag-of-class-p tag 'alias)
(:override
(semantic-tag-get-attribute tag :definition))))