summaryrefslogtreecommitdiff
path: root/lisp/cedet/semantic
diff options
context:
space:
mode:
authorPaul Eggert <eggert@cs.ucla.edu>2019-11-11 10:30:13 -0800
committerPaul Eggert <eggert@cs.ucla.edu>2019-11-11 10:32:53 -0800
commit6b4a97c1c78f39ce890d100acceceb652d14e20d (patch)
tree9d9f8347a952226adcd73680ed89c5679d6e5326 /lisp/cedet/semantic
parent269796288a43520a1dcc481337af472d086faaa4 (diff)
downloademacs-6b4a97c1c78f39ce890d100acceceb652d14e20d.tar.gz
Fix some quoting glitches in doc strings
Diffstat (limited to 'lisp/cedet/semantic')
-rw-r--r--lisp/cedet/semantic/analyze.el2
-rw-r--r--lisp/cedet/semantic/ctxt.el2
-rw-r--r--lisp/cedet/semantic/db-find.el2
-rw-r--r--lisp/cedet/semantic/db-typecache.el2
-rw-r--r--lisp/cedet/semantic/edit.el4
-rw-r--r--lisp/cedet/semantic/find.el4
-rw-r--r--lisp/cedet/semantic/grammar.el2
-rw-r--r--lisp/cedet/semantic/java.el2
-rw-r--r--lisp/cedet/semantic/lex-spp.el4
-rw-r--r--lisp/cedet/semantic/mru-bookmark.el2
-rw-r--r--lisp/cedet/semantic/scope.el11
-rw-r--r--lisp/cedet/semantic/symref.el8
-rw-r--r--lisp/cedet/semantic/tag-ls.el2
-rw-r--r--lisp/cedet/semantic/texi.el4
-rw-r--r--lisp/cedet/semantic/wisent/comp.el2
-rw-r--r--lisp/cedet/semantic/wisent/javascript.el4
16 files changed, 29 insertions, 28 deletions
diff --git a/lisp/cedet/semantic/analyze.el b/lisp/cedet/semantic/analyze.el
index 6851ad556a7..d3cbe610a79 100644
--- a/lisp/cedet/semantic/analyze.el
+++ b/lisp/cedet/semantic/analyze.el
@@ -356,7 +356,7 @@ This function knows of flags:
(defun semantic-analyze-find-tag (name &optional tagclass scope)
"Return the first tag found with NAME or nil if not found.
Optional argument TAGCLASS specifies the class of tag to return,
-such as 'function or 'variable.
+such as `function' or `variable'.
Optional argument SCOPE specifies a scope object which has
additional tags which are in SCOPE and do not need prefixing to
find.
diff --git a/lisp/cedet/semantic/ctxt.el b/lisp/cedet/semantic/ctxt.el
index 54ef2ee7594..2f6eba467bf 100644
--- a/lisp/cedet/semantic/ctxt.el
+++ b/lisp/cedet/semantic/ctxt.el
@@ -55,7 +55,7 @@ Used for identifying arguments to functions.")
Return non-nil if there are no more context levels.
Overloaded functions using `up-context' take no parameters.
BOUNDS-TYPE is a symbol representing a tag class to restrict
-movement to. If this is nil, 'function is used.
+movement to. If this is nil, `function' is used.
This will find the smallest tag of that class (function, variable,
type, etc) and make sure non-nil is returned if you cannot
go up past the bounds of that tag."
diff --git a/lisp/cedet/semantic/db-find.el b/lisp/cedet/semantic/db-find.el
index 18c749b098e..9a81d18b7d5 100644
--- a/lisp/cedet/semantic/db-find.el
+++ b/lisp/cedet/semantic/db-find.el
@@ -434,7 +434,7 @@ Default action as described in `semanticdb-find-translate-path'."
"All include tags scanned, plus action taken on the tag.
Each entry is an alist:
(ACTION . TAG)
-where ACTION is one of 'scanned, 'duplicate, 'lost
+where ACTION is one of `scanned', `duplicate', `lost'
and TAG is a clone of the include tag that was found.")
(make-variable-buffer-local 'semanticdb-find-scanned-include-tags)
diff --git a/lisp/cedet/semantic/db-typecache.el b/lisp/cedet/semantic/db-typecache.el
index 7e0f52fe0b3..a6d9b3c7979 100644
--- a/lisp/cedet/semantic/db-typecache.el
+++ b/lisp/cedet/semantic/db-typecache.el
@@ -412,7 +412,7 @@ found tag to be loaded."
(defun semanticdb-typecache-find-by-name-helper (name table)
"Find the tag with NAME in TABLE, which is from a typecache.
If more than one tag has NAME in TABLE, we will prefer the tag that
-is of class 'type."
+is of class `type'."
(let* ((names (semantic-find-tags-by-name name table))
(nmerge (semanticdb-typecache-merge-streams names nil))
(types (semantic-find-tags-by-class 'type nmerge)))
diff --git a/lisp/cedet/semantic/edit.el b/lisp/cedet/semantic/edit.el
index 2a25bb5db1c..9319e02c417 100644
--- a/lisp/cedet/semantic/edit.el
+++ b/lisp/cedet/semantic/edit.el
@@ -464,7 +464,7 @@ See `semantic-edits-change-leaf-tag' for details on parents."
(defun semantic-parse-changes-failed (&rest args)
"Signal that Semantic failed to parse changes.
That is, display a message by passing all ARGS to `format-message', then throw
-a 'semantic-parse-changes-failed exception with value t."
+a `semantic-parse-changes-failed' exception with value t."
(when semantic-edits-verbose-flag
(message "Semantic parse changes failed: %S"
(apply #'format-message args)))
@@ -516,7 +516,7 @@ the semantic cache to see what needs to be changed."
(defun semantic-edits-incremental-parser-1 ()
"Incrementally reparse the current buffer.
Return the list of tags that changed.
-If the incremental parse fails, throw a 'semantic-parse-changes-failed
+If the incremental parse fails, throw a `semantic-parse-changes-failed'
exception with value t, that can be caught to schedule a full reparse.
This function is for internal use by `semantic-edits-incremental-parser'."
(let* ((changed-tags nil)
diff --git a/lisp/cedet/semantic/find.el b/lisp/cedet/semantic/find.el
index ec38a37295f..8b01b25d99e 100644
--- a/lisp/cedet/semantic/find.el
+++ b/lisp/cedet/semantic/find.el
@@ -307,7 +307,7 @@ attempting to do completions."
(defmacro semantic-find-tags-by-class (class &optional table)
"Find all tags of class CLASS in TABLE.
CLASS is a symbol representing the class of the token, such as
-'variable, of 'function..
+`variable' or `function'.
TABLE is a tag table. See `semantic-something-to-tag-table'."
`(semantic--find-tags-by-macro
(eq ,class (semantic-tag-class (car tags)))
@@ -316,7 +316,7 @@ TABLE is a tag table. See `semantic-something-to-tag-table'."
(defmacro semantic-filter-tags-by-class (class &optional table)
"Find all tags of class not in the list CLASS in TABLE.
CLASS is a list of symbols representing the class of the token,
-such as 'variable, of 'function..
+such as `variable' or `function'.
TABLE is a tag table. See `semantic-something-to-tag-table'."
`(semantic--find-tags-by-macro
(not (memq (semantic-tag-class (car tags)) ,class))
diff --git a/lisp/cedet/semantic/grammar.el b/lisp/cedet/semantic/grammar.el
index 53b5ea61f2d..785a05816b7 100644
--- a/lisp/cedet/semantic/grammar.el
+++ b/lisp/cedet/semantic/grammar.el
@@ -1738,7 +1738,7 @@ Otherwise return nil."
(define-mode-local-override semantic-tag-boundary-p
semantic-grammar-mode (tag)
"Return non-nil for tags that should have a boundary drawn.
-Only tags of type 'nonterminal will be so marked."
+Only tags of type `nonterminal' will be so marked."
(let ((c (semantic-tag-class tag)))
(eq c 'nonterminal)))
diff --git a/lisp/cedet/semantic/java.el b/lisp/cedet/semantic/java.el
index b103c3ce157..f81ad74cf90 100644
--- a/lisp/cedet/semantic/java.el
+++ b/lisp/cedet/semantic/java.el
@@ -281,7 +281,7 @@ Optional argument COLOR indicates that color should be mixed in."
Java have documentation set in a comment preceding TAG's definition.
Attempt to strip out comment syntactic sugar, unless optional argument
NOSNARF is non-nil.
-If NOSNARF is 'lex, then return the semantic lex token."
+If NOSNARF is `lex', then return the semantic lex token."
(when (or tag (setq tag (semantic-current-tag)))
(with-current-buffer (semantic-tag-buffer tag)
(save-excursion
diff --git a/lisp/cedet/semantic/lex-spp.el b/lisp/cedet/semantic/lex-spp.el
index a81b23ca750..2de579b5b3a 100644
--- a/lisp/cedet/semantic/lex-spp.el
+++ b/lisp/cedet/semantic/lex-spp.el
@@ -698,7 +698,7 @@ and what valid VAL values are."
(defun semantic-lex-spp-symbol-merge (txt)
"Merge the tokens listed in TXT.
-TXT might contain further 'spp-symbol-merge, which will
+TXT might contain further `spp-symbol-merge', which will
be merged recursively."
;; We need to merge the tokens in the 'text segment together,
;; and produce a single symbol from it.
@@ -1272,7 +1272,7 @@ VALFORM are forms that return the name of the thing being included, and the
type of include. The return value should be of the form:
(NAME . TYPE)
where NAME is the name of the include, and TYPE is the type of the include,
-where a valid symbol is 'system, or nil."
+where a valid symbol is `system', or nil."
(let ((start (make-symbol "start"))
(end (make-symbol "end"))
(val (make-symbol "val"))
diff --git a/lisp/cedet/semantic/mru-bookmark.el b/lisp/cedet/semantic/mru-bookmark.el
index 13cfc586fd7..461097ecb7c 100644
--- a/lisp/cedet/semantic/mru-bookmark.el
+++ b/lisp/cedet/semantic/mru-bookmark.el
@@ -77,7 +77,7 @@ Set this when the tag gets unlinked from the buffer it belongs to.")
:initform t
:documentation
"The reason this tag is interesting.
-Nice values are 'edit, 'read, 'jump, and 'mark.
+Nice values include the following:
edit - created because the tag text was edited.
read - created because point lingered in tag text.
jump - jumped to another tag from this tag.
diff --git a/lisp/cedet/semantic/scope.el b/lisp/cedet/semantic/scope.el
index 3b38e8a61c3..5dc49d6cb3c 100644
--- a/lisp/cedet/semantic/scope.el
+++ b/lisp/cedet/semantic/scope.el
@@ -461,8 +461,8 @@ implicit \"object\"."
(define-overloadable-function semantic-analyze-scope-calculate-access (type scope)
"Calculate the access class for TYPE as defined by the current SCOPE.
Access is related to the :parents in SCOPE. If type is a member of SCOPE
-then access would be 'private. If TYPE is inherited by a member of SCOPE,
-the access would be 'protected. Otherwise, access is 'public")
+then access would be `private'. If TYPE is inherited by a member of SCOPE,
+the access would be `protected'. Otherwise, access is `public'.")
(defun semantic-analyze-scope-calculate-access-default (type scope)
"Calculate the access class for TYPE as defined by the current SCOPE."
@@ -545,7 +545,8 @@ tag is not something you can complete from within TYPE."
"Return all parts of TYPE, a tag representing a TYPE declaration.
SCOPE is the scope object.
NOINHERIT turns off searching of inherited tags.
-PROTECTION specifies the type of access requested, such as 'public or 'private."
+PROTECTION specifies the type of access requested,
+such as `public' or `private'."
(if (not type)
nil
(let* ((access (semantic-analyze-scope-calculate-access type scope))
@@ -593,8 +594,8 @@ whose tags can be searched when needed, OR it may be a scope object.
ACCESS is the level of access we filter on child supplied tags.
For languages with protection on specific methods or slots,
it should strip out those not accessible by methods of TYPE.
-An ACCESS of 'public means not in a method of a subclass of type.
-A value of 'private means we can access private parts of the originating
+An ACCESS of `public' means not in a method of a subclass of type.
+A value of `private' means we can access private parts of the originating
type."
(let ((ret nil))
(semantic-analyze-scoped-inherited-tag-map
diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el
index 85acd50712b..f7404fc0177 100644
--- a/lisp/cedet/semantic/symref.el
+++ b/lisp/cedet/semantic/symref.el
@@ -78,7 +78,7 @@
;;; Code:
(defcustom semantic-symref-tool 'detect
"The active symbol reference tool name.
-The tool symbol can be 'detect, or a symbol that is the name of
+The tool symbol can be `detect', or a symbol that is the name of
a tool that can be used for symbol referencing."
:type 'symbol
:group 'semantic)
@@ -309,9 +309,9 @@ Can be 'project, 'target, or 'file.")
:type symbol
:documentation
"The kind of search results desired.
-Can be 'line, 'file, or 'tag.
-The type of result can be converted from 'line to 'file, or 'line to 'tag,
-but not from 'file to 'line or 'tag.")
+Can be `line', `file', or `tag'.
+The type of result can be converted from `line' to `file', or `line' to `tag',
+but not from `file' to `line' or `tag'.")
)
"Baseclass for all symbol references tools.
A symbol reference tool supplies functionality to identify the locations of
diff --git a/lisp/cedet/semantic/tag-ls.el b/lisp/cedet/semantic/tag-ls.el
index ad072a40960..04a6b4e99ff 100644
--- a/lisp/cedet/semantic/tag-ls.el
+++ b/lisp/cedet/semantic/tag-ls.el
@@ -199,7 +199,7 @@ Other languages qualify names within a Namespace (such as C++) which
result in a different package like structure.
Languages which do not override this function will just search the
-stream for a tag of class 'package, and return that."
+stream for a tag of class `package', and return that."
(let ((stream (semantic-something-to-tag-table
(or stream-or-buffer tag))))
(:override-with-args (tag stream))))
diff --git a/lisp/cedet/semantic/texi.el b/lisp/cedet/semantic/texi.el
index 7d663f3e3ac..e5b5823dad5 100644
--- a/lisp/cedet/semantic/texi.el
+++ b/lisp/cedet/semantic/texi.el
@@ -300,8 +300,8 @@ can handle the @menu environment.")
texinfo-mode (&optional point)
"Determine the class of tags that can be used at POINT.
For texinfo, there two possibilities returned.
-1) 'function - for a call to a texinfo function
-2) 'word - indicates an english word.
+1) `function' - for a call to a texinfo function
+2) `word' - indicates an English word.
It would be nice to know function arguments too, but not today."
(let ((sym (semantic-ctxt-current-symbol)))
(if (and sym (= (aref (car sym) 0) ?@))
diff --git a/lisp/cedet/semantic/wisent/comp.el b/lisp/cedet/semantic/wisent/comp.el
index 787e30c342a..ace05e9f4b6 100644
--- a/lisp/cedet/semantic/wisent/comp.el
+++ b/lisp/cedet/semantic/wisent/comp.el
@@ -2641,7 +2641,7 @@ Decide what to do for each type of token if seen as the lookahead
token in specified state. The value returned is used as the default
action for the state. In addition, ACTROW is filled with what to do
for each kind of token, index by symbol number, with nil meaning do
-the default action. The value 'error, means this situation is an
+the default action. The value `error', means this situation is an
error. The parser recognizes this value specially.
This is where conflicts are resolved. The loop over lookahead rules
diff --git a/lisp/cedet/semantic/wisent/javascript.el b/lisp/cedet/semantic/wisent/javascript.el
index 4c93c0dc4fa..e17dc68e1f6 100644
--- a/lisp/cedet/semantic/wisent/javascript.el
+++ b/lisp/cedet/semantic/wisent/javascript.el
@@ -88,8 +88,8 @@ is to return a symbol based on type modifiers."
(define-mode-local-override semantic-analyze-scope-calculate-access js-mode (type scope)
"Calculate the access class for TYPE as defined by the current SCOPE.
Access is related to the :parents in SCOPE. If type is a member of SCOPE
-then access would be 'private. If TYPE is inherited by a member of SCOPE,
-the access would be 'protected. Otherwise, access is 'public."
+then access would be `private'. If TYPE is inherited by a member of SCOPE,
+the access would be `protected'. Otherwise, access is `public'."
nil)
(define-mode-local-override semantic-ctxt-current-symbol js-mode (&optional point)