mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-26 07:33:47 +00:00
Quote symbols in docstrings using `'
Be more systematic about quoting symbols `like-this' rather than `like-this or 'like-this' in docstrings. This follows up Artur Malabarba's email in: http://lists.gnu.org/archive/html/emacs-devel/2015-11/msg01647.html
This commit is contained in:
parent
3e309ad86c
commit
bb4303c536
@ -316,7 +316,7 @@ Default action as described in `semanticdb-find-translate-path'."
|
||||
;;;###autoload
|
||||
(define-overloadable-function semanticdb-find-table-for-include (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."
|
||||
)
|
||||
|
@ -378,11 +378,11 @@ See `semantic-tag-protected-p' for details on which tags are returned."
|
||||
|
||||
;;;###autoload
|
||||
(define-overloadable-function semantic-find-tags-included (&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'.")
|
||||
|
||||
(defun semantic-find-tags-included-default (&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'.
|
||||
By default, just call `semantic-find-tags-by-class'."
|
||||
(semantic-find-tags-by-class 'include table))
|
||||
|
@ -171,7 +171,7 @@ That is remove the unsupported :help stuff."
|
||||
NAME specifies a special name that can be searched for later to
|
||||
recover the cached data with `semantic-get-cache-data'.
|
||||
LIFESPAN indicates how long the data cache will be remembered.
|
||||
The default LIFESPAN is 'end-of-command.
|
||||
The default LIFESPAN is `end-of-command'.
|
||||
Possible Lifespans are:
|
||||
`end-of-command' - Remove the cache at the end of the currently
|
||||
executing command.
|
||||
|
@ -958,8 +958,8 @@ Return nil if TAG is not of class `alias'."
|
||||
"Return a list of components for TAG.
|
||||
A Component is a part of TAG which itself may be a TAG.
|
||||
Examples include the elements of a structure in a
|
||||
tag of class 'type, or the list of arguments to a
|
||||
tag of class 'function."
|
||||
tag of class `type', or the list of arguments to a
|
||||
tag of class `function'."
|
||||
)
|
||||
|
||||
(defun semantic-tag-components-default (tag)
|
||||
|
@ -2419,9 +2419,9 @@ If STRING is nil, the function does nothing."
|
||||
"Display STRING in the ERC BUFFER.
|
||||
All screen output must be done through this function. If BUFFER is nil
|
||||
or omitted, the default ERC buffer for the `erc-session-server' is used.
|
||||
The BUFFER can be an actual buffer, a list of buffers, 'all or 'active.
|
||||
If BUFFER = 'all, the string is displayed in all the ERC buffers for the
|
||||
current session. 'active means the current active buffer
|
||||
The BUFFER can be an actual buffer, a list of buffers, `all' or `active'.
|
||||
If BUFFER = `all', the string is displayed in all the ERC buffers for the
|
||||
current session. `active' means the current active buffer
|
||||
\(`erc-active-buffer'). If the buffer can't be resolved, the current
|
||||
buffer is used. `erc-display-line-1' is used to display STRING.
|
||||
|
||||
|
@ -756,7 +756,7 @@ matching item, even without typing a slash."
|
||||
(defcustom ido-create-new-buffer 'prompt
|
||||
"Specify whether a new buffer is created if no buffer matches substring.
|
||||
Choices are `always' to create new buffers unconditionally, `prompt' to
|
||||
ask user whether to create buffer, or 'never to never create new buffer."
|
||||
ask user whether to create buffer, or `never' to never create new buffer."
|
||||
:type '(choice (const always)
|
||||
(const prompt)
|
||||
(const never))
|
||||
|
@ -1869,7 +1869,7 @@ Generally, the list should not include the (usually overly large)
|
||||
|
||||
(defun eww-restore-desktop (file-name buffer-name misc-data)
|
||||
"Restore an eww buffer from its desktop file record.
|
||||
If `eww-restore-desktop' is t or 'auto, this function will also
|
||||
If `eww-restore-desktop' is t or `auto', this function will also
|
||||
initiate the retrieval of the respective URI in the background.
|
||||
Otherwise, the restored buffer will contain a prompt to do so by using
|
||||
\\[eww-reload]."
|
||||
|
@ -469,9 +469,9 @@ KIND is either `code' or `comment'. Optional fourth arg B-OFFSET
|
||||
when added to B specifies the actual buffer position where the block
|
||||
begins. Likewise for optional fifth arg E-OFFSET. If unspecified
|
||||
they are taken to be 0 (zero). The following properties are set
|
||||
in the overlay: 'invisible 'hs 'hs-b-offset 'hs-e-offset. Also,
|
||||
in the overlay: `invisible' `hs' `hs-b-offset' `hs-e-offset'. Also,
|
||||
depending on variable `hs-isearch-open', the following properties may
|
||||
be present: 'isearch-open-invisible 'isearch-open-invisible-temporary.
|
||||
be present: `isearch-open-invisible' `isearch-open-invisible-temporary'.
|
||||
If variable `hs-set-up-overlay' is non-nil it should specify a function
|
||||
to call with the newly initialized overlay."
|
||||
(unless b-offset (setq b-offset 0))
|
||||
|
@ -128,7 +128,7 @@
|
||||
|
||||
(defun mantemp-insert-cxx-syntax ()
|
||||
"Insert C++ syntax around each template class and function.
|
||||
Insert `template class' for classes, 'template' for
|
||||
Insert `template class' for classes, `template' for
|
||||
functions and add the statement delimiter `;' at the end of
|
||||
the lines."
|
||||
(save-excursion
|
||||
|
Loading…
Reference in New Issue
Block a user