procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix typos in docstrings, error messages, etc.

Browse source
This commit is contained in:
Juanma Barranquero 2010-01-18 05:39:40 +01:00
parent 33972e8014
commit db9e401b3b
20 changed files with 235 additions and 148 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lisp/cedet/semantic/db-ebrowse.el
View file

@ -90,7 +90,7 @@ be searched."
:initarg :global-extract
:documentation
"Table of ebrowse tags specific to this file.
This table is compisited from the ebrowse *Globals* section.")
This table is composited from the ebrowse *Globals* section.")
)
"A table for returning search results from ebrowse.")
@ -128,7 +128,7 @@ EBROWSE is a C/C++ parser for use with `ebrowse' Emacs program.")
)))
(defun semanticdb-create-ebrowse-database (dir)
"Create an EBROSE database for directory DIR.
"Create an EBROWSE database for directory DIR.
The database file is stored in ~/.semanticdb, or whichever directory
is specified by `semanticdb-default-save-directory'."
(interactive "DDirectory: ")
@ -597,7 +597,7 @@ Return a list of tags."
(defmethod semanticdb-find-tags-for-completion-method
((table semanticdb-table-ebrowse) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(if tags (call-next-method)
@ -607,7 +607,7 @@ Returns a table of all matching tags."
(defmethod semanticdb-find-tags-by-class-method
((table semanticdb-table-ebrowse) class &optional tags)
"In TABLE, find all occurances of tags of CLASS.
"In TABLE, find all occurrences of tags of CLASS.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(if tags (call-next-method)
@ -625,7 +625,7 @@ Returns a table of all matching tags."
(defmethod semanticdb-deep-find-tags-by-name-method
((table semanticdb-table-ebrowse) name &optional tags)
"Find all tags name NAME in TABLE.
Optional argument TAGS is a list of tags t
Optional argument TAGS is a list of tags to search.
Like `semanticdb-find-tags-by-name-method' for ebrowse."
;;(semanticdb-find-tags-by-name-method table name tags)
(call-next-method))
@ -640,7 +640,7 @@ Like `semanticdb-find-tags-by-name-method' for ebrowse."
(defmethod semanticdb-deep-find-tags-for-completion-method
((table semanticdb-table-ebrowse) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Like `semanticdb-find-tags-for-completion-method' for ebrowse."
;;(semanticdb-find-tags-for-completion-method table prefix tags)

14
lisp/cedet/semantic/db-el.el
View file

@ -76,7 +76,7 @@ It does not need refreshing."
(defvar-mode-local emacs-lisp-mode semanticdb-find-default-throttle
'(project omniscience)
"Search project files, then search this omniscience database.
It is not necessary to to system or recursive searching because of
It is not necessary to do system or recursive searching because of
the omniscience database.")
;;; Filename based methods
@ -246,12 +246,12 @@ TOKTYPE is a hint to the type of tag desired."
;;; Search Overrides
;;
(defvar semanticdb-elisp-mapatom-collector nil
"Variable used to collect mapatoms output.")
"Variable used to collect `mapatoms' output.")
(defmethod semanticdb-find-tags-by-name-method
((table semanticdb-table-emacs-lisp) name &optional tags)
"Find all tags name NAME in TABLE.
Uses `inter-soft' to match NAME to emacs symbols.
"Find all tags named NAME in TABLE.
Uses `intern-soft' to match NAME to Emacs symbols.
Return a list of tags."
(if tags (call-next-method)
;; No need to search. Use `intern-soft' which does the same thing for us.
@ -281,7 +281,7 @@ Return a list of tags."
(defmethod semanticdb-find-tags-for-completion-method
((table semanticdb-table-emacs-lisp) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(if tags (call-next-method)
@ -290,7 +290,7 @@ Returns a table of all matching tags."
(defmethod semanticdb-find-tags-by-class-method
((table semanticdb-table-emacs-lisp) class &optional tags)
"In TABLE, find all occurances of tags of CLASS.
"In TABLE, find all occurrences of tags of CLASS.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(if tags (call-next-method)
@ -316,7 +316,7 @@ Like `semanticdb-find-tags-by-name-method' for Emacs Lisp."
(defmethod semanticdb-deep-find-tags-for-completion-method
((table semanticdb-table-emacs-lisp) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Like `semanticdb-find-tags-for-completion-method' for Emacs Lisp."
(semanticdb-find-tags-for-completion-method table prefix tags))

30
lisp/cedet/semantic/db-find.el
View file

@ -281,7 +281,7 @@ identified by translating PATH. Such searches use brute force to
scan every available table.
The return value is a list of objects of type `semanticdb-table' or
it's children. In the case of passing in a find result, the result
their children. In the case of passing in a find result, the result
is returned unchanged.
This routine uses `semanticdb-find-table-for-include' to translate
@ -366,7 +366,7 @@ Default action as described in `semanticdb-find-translate-path'."
ans))
(defun semanticdb-find-need-cache-update-p (table)
"Non nil if the semanticdb TABLE cache needs to be updated."
"Non-nil if the semanticdb TABLE cache needs to be updated."
;; If we were passed in something related to a TABLE,
;; do a caching lookup.
(let* ((index (semanticdb-get-table-index table))
@ -431,7 +431,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)
@ -927,7 +927,7 @@ but should be good enough for debugging assertions."
(defun semanticdb-find-result-with-nil-p (resultp)
"Non-nil of RESULTP is in the form of a semanticdb search result.
nil is a valid value where a TABLE usually is, but only if the TAG
The value nil is valid where a TABLE usually is, but only if the TAG
results include overlays.
This query only really tests the first entry in the list that is RESULTP,
but should be good enough for debugging assertions."
@ -1090,8 +1090,8 @@ Returns result."
"Collect all tags returned by FUNCTION over PATH.
The FUNCTION must take two arguments. The first is TABLE,
which is a semanticdb table containing tags. The second argument
to FUNCTION is TAGS. TAGS may be a list of tags. If TAGS is non-nil, then
FUNCTION should search the TAG list, not through TABLE.
to FUNCTION is TAGS. TAGS may be a list of tags. If TAGS is non-nil,
then FUNCTION should search the TAG list, not through TABLE.
See `semanticdb-find-translate-path' for details on PATH.
FIND-FILE-MATCH indicates that any time a match is found, the file
@ -1296,38 +1296,38 @@ associated with that tag should be loaded into a buffer."
;;; Top level Searches
(defmethod semanticdb-find-tags-by-name-method ((table semanticdb-abstract-table) name &optional tags)
"In TABLE, find all occurances of tags with NAME.
"In TABLE, find all occurrences of tags with NAME.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(semantic-find-tags-by-name name (or tags (semanticdb-get-tags table))))
(defmethod semanticdb-find-tags-by-name-regexp-method ((table semanticdb-abstract-table) regexp &optional tags)
"In TABLE, find all occurances of tags matching REGEXP.
"In TABLE, find all occurrences of tags matching REGEXP.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(semantic-find-tags-by-name-regexp regexp (or tags (semanticdb-get-tags table))))
(defmethod semanticdb-find-tags-for-completion-method ((table semanticdb-abstract-table) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(semantic-find-tags-for-completion prefix (or tags (semanticdb-get-tags table))))
(defmethod semanticdb-find-tags-by-class-method ((table semanticdb-abstract-table) class &optional tags)
"In TABLE, find all occurances of tags of CLASS.
"In TABLE, find all occurrences of tags of CLASS.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(semantic-find-tags-by-class class (or tags (semanticdb-get-tags table))))
(defmethod semanticdb-find-tags-external-children-of-type-method ((table semanticdb-abstract-table) parent &optional tags)
"In TABLE, find all occurances of tags whose parent is the PARENT type.
"In TABLE, find all occurrences of tags whose parent is the PARENT type.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(require 'semantic/find)
(semantic-find-tags-external-children-of-type parent (or tags (semanticdb-get-tags table))))
(defmethod semanticdb-find-tags-subclasses-of-type-method ((table semanticdb-abstract-table) parent &optional tags)
"In TABLE, find all occurances of tags whose parent is the PARENT type.
"In TABLE, find all occurrences of tags whose parent is the PARENT type.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(require 'semantic/find)
@ -1335,7 +1335,7 @@ Returns a table of all matching tags."
;;; Deep Searches
(defmethod semanticdb-deep-find-tags-by-name-method ((table semanticdb-abstract-table) name &optional tags)
"In TABLE, find all occurances of tags with NAME.
"In TABLE, find all occurrences of tags with NAME.
Search in all tags in TABLE, and all components of top level tags in
TABLE.
Optional argument TAGS is a list of tags to search.
@ -1343,7 +1343,7 @@ Return a table of all matching tags."
(semantic-find-tags-by-name name (semantic-flatten-tags-table (or tags (semanticdb-get-tags table)))))
(defmethod semanticdb-deep-find-tags-by-name-regexp-method ((table semanticdb-abstract-table) regexp &optional tags)
"In TABLE, find all occurances of tags matching REGEXP.
"In TABLE, find all occurrences of tags matching REGEXP.
Search in all tags in TABLE, and all components of top level tags in
TABLE.
Optional argument TAGS is a list of tags to search.
@ -1351,7 +1351,7 @@ Return a table of all matching tags."
(semantic-find-tags-by-name-regexp regexp (semantic-flatten-tags-table (or tags (semanticdb-get-tags table)))))
(defmethod semanticdb-deep-find-tags-for-completion-method ((table semanticdb-abstract-table) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Search in all tags in TABLE, and all components of top level tags in
TABLE.
Optional argument TAGS is a list of tags to search.

12
lisp/cedet/semantic/db-global.el
View file

@ -66,7 +66,7 @@ in a GNU Global supported hierarchy."
)
(defun semanticdb-enable-gnu-global-hook ()
"Add support for GNU Global in the current buffer via semantic-init-hook.
"Add support for GNU Global in the current buffer via `semantic-init-hook'.
MODE is the major mode to support."
(semanticdb-enable-gnu-global-in-buffer t))
@ -78,8 +78,8 @@ MODE is the major mode to support."
(defun semanticdb-enable-gnu-global-in-buffer (&optional dont-err-if-not-available)
"Enable a GNU Global database in the current buffer.
Argument DONT-ERR-IF-NOT-AVAILABLE will throw an error if GNU Global
is not available for this directory."
When GNU Global is not available for this directory, display a message
if optional DONT-ERR-IF-NOT-AVAILABLE is non-nil; else throw an error."
(interactive "P")
(if (cedet-gnu-global-root)
(setq
@ -168,7 +168,7 @@ Return a list of tags."
(defmethod semanticdb-find-tags-for-completion-method
((table semanticdb-table-global) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(if tags (call-next-method)
@ -195,7 +195,7 @@ Returns a table of all matching tags."
(defmethod semanticdb-deep-find-tags-by-name-method
((table semanticdb-table-global) name &optional tags)
"Find all tags name NAME in TABLE.
Optional argument TAGS is a list of tags t
Optional argument TAGS is a list of tags to search.
Like `semanticdb-find-tags-by-name-method' for global."
(semanticdb-find-tags-by-name-method table name tags))
@ -208,7 +208,7 @@ Like `semanticdb-find-tags-by-name-method' for global."
(defmethod semanticdb-deep-find-tags-for-completion-method
((table semanticdb-table-global) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Like `semanticdb-find-tags-for-completion-method' for global."
(semanticdb-find-tags-for-completion-method table prefix tags))

18
lisp/cedet/semantic/db-javascript.el
View file

@ -77,7 +77,7 @@
(("uriComponent" variable nil nil nil)))
nil nil))
"Hard-coded list of javascript tags for semanticdb.
See bottom of this file for instruction on managing this list.")
See bottom of this file for instructions on managing this list.")
;;; Classes:
(defclass semanticdb-table-javascript (semanticdb-search-results-table)
@ -87,7 +87,7 @@ See bottom of this file for instruction on managing this list.")
(defclass semanticdb-project-database-javascript
(semanticdb-project-database
eieio-singleton ;this db is for js globals, so singleton is apropriate
eieio-singleton ;this db is for js globals, so singleton is appropriate
)
((new-table-class :initform semanticdb-table-javascript
:type class
@ -107,7 +107,7 @@ See bottom of this file for instruction on managing this list.")
(defvar-mode-local javascript-mode semanticdb-find-default-throttle
'(project omniscience)
"Search project files, then search this omniscience database.
It is not necessary to to system or recursive searching because of
It is not necessary to do system or recursive searching because of
the omniscience database.")
;;; Filename based methods
@ -157,7 +157,7 @@ local variable."
;; to a search list.
(define-mode-local-override semanticdb-find-translate-path javascript-mode
(path brutish)
"Return a list of semanticdb tables asociated with PATH.
"Return a list of semanticdb tables associated with PATH.
If brutish, do the default action.
If not brutish, do the default action, and append the system
database (if available.)"
@ -216,7 +216,7 @@ Return a list of tags."
(defmethod semanticdb-find-tags-for-completion-method
((table semanticdb-table-javascript) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(if tags (call-next-method)
@ -226,7 +226,7 @@ Returns a table of all matching tags."
(defmethod semanticdb-find-tags-by-class-method
((table semanticdb-table-javascript) class &optional tags)
"In TABLE, find all occurances of tags of CLASS.
"In TABLE, find all occurrences of tags of CLASS.
Optional argument TAGS is a list of tags to search.
Returns a table of all matching tags."
(if tags (call-next-method)
@ -248,7 +248,7 @@ Returns a table of all matching tags."
(defmethod semanticdb-deep-find-tags-by-name-method
((table semanticdb-table-javascript) name &optional tags)
"Find all tags name NAME in TABLE.
Optional argument TAGS is a list of tags t
Optional argument TAGS is a list of tags to search.
Like `semanticdb-find-tags-by-name-method' for javascript."
(semanticdb-find-tags-by-name-method table name tags))
@ -261,7 +261,7 @@ Like `semanticdb-find-tags-by-name-method' for javascript."
(defmethod semanticdb-deep-find-tags-for-completion-method
((table semanticdb-table-javascript) prefix &optional tags)
"In TABLE, find all occurances of tags matching PREFIX.
"In TABLE, find all occurrences of tags matching PREFIX.
Optional argument TAGS is a list of tags to search.
Like `semanticdb-find-tags-for-completion-method' for javascript."
(semanticdb-find-tags-for-completion-method table prefix tags))
@ -270,7 +270,7 @@ Like `semanticdb-find-tags-for-completion-method' for javascript."
;;
(defmethod semanticdb-find-tags-external-children-of-type-method
((table semanticdb-table-javascript) type &optional tags)
"Find all nonterminals which are child elements of TYPE
"Find all nonterminals which are child elements of TYPE.
Optional argument TAGS is a list of tags to search.
Return a list of tags."
(if tags (call-next-method)

8
lisp/cedet/semantic/idle.el
View file

@ -367,7 +367,7 @@ Returns t if all processing succeeded."
(defun semantic-idle-work-core-handler ()
"Core handler for idle work processing of long running tasks.
Visits semantic controlled buffers, and makes sure all needed
Visits Semantic controlled buffers, and makes sure all needed
include files have been parsed, and that the typecache is up to date.
Uses `semantic-idle-work-for-on-buffer' to do the work."
(let ((errbuf nil)
@ -577,7 +577,7 @@ Does nothing if the current buffer doesn't need reparsing."
DOC will be a documentation string describing FORMS.
FORMS will be called during idle time after the current buffer's
semantic tag information has been updated.
This routines creates the following functions and variables:"
This routine creates the following functions and variables:"
(let ((global (intern (concat "global-" (symbol-name name) "-mode")))
(mode (intern (concat (symbol-name name) "-mode")))
(hook (intern (concat (symbol-name name) "-mode-hook")))
@ -764,7 +764,7 @@ specific to a major mode. For example, in jde mode:
jde-java-font-lock-code-face)))")
(defun semantic-idle-summary-useful-context-p ()
"Non-nil of we should show a summary based on context."
"Non-nil if we should show a summary based on context."
(if (and (boundp 'font-lock-mode)
font-lock-mode
(memq (get-text-property (point) 'face)
@ -959,7 +959,7 @@ Call `semantic-symref-hits-in-region' to identify local references."
;;;###autoload
(defun global-semantic-idle-scheduler-mode (&optional arg)
"Toggle global use of option `semantic-idle-scheduler-mode'.
The idle scheduler with automatically reparse buffers in idle time,
The idle scheduler will automatically reparse buffers in idle time,
and then schedule other jobs setup with `semantic-idle-scheduler-add'.
If ARG is positive, enable, if it is negative, disable.
If ARG is nil, then toggle."

20
lisp/cedet/semantic/util-modes.el
View file

@ -337,7 +337,7 @@ semantic parser cannot match is highlighted with a red underline."
(((class color) (background light))
(:underline "red")))
"Face used to show unmatched syntax in.
The face is used in `semantic-show-unmatched-syntax-mode'."
The face is used in `semantic-show-unmatched-syntax-mode'."
:group 'semantic-faces)
(defsubst semantic-unmatched-syntax-overlay-p (overlay)
@ -767,7 +767,7 @@ This makes it appear that the first line of that tag is
]
[ "Narrow To Headerline Tag" senator-narrow-to-defun
:active (semantic-current-tag)
:help "Narrow to the bounds of the current tag."]
:help "Narrow to the bounds of the current tag"]
[ "Fold Headerline Tag" senator-fold-tag-toggle
:active (semantic-current-tag)
:style toggle
@ -854,7 +854,7 @@ when it lands in the sticky line."
:type 'string)
(defvar semantic-stickyfunc-old-hlf nil
"Value of the header line when entering sticky func mode.")
"Value of the header line when entering stickyfunc mode.")
(defconst semantic-stickyfunc-header-line-format
(cond ((featurep 'xemacs)
@ -868,7 +868,7 @@ when it lands in the sticky line."
'(:eval (list semantic-stickyfunc-indent-string
(semantic-stickyfunc-fetch-stickyline))))
(t nil))
"The header line format used by sticky func mode.")
"The header line format used by stickyfunc mode.")
(defun semantic-stickyfunc-mode-setup ()
"Setup option `semantic-stickyfunc-mode'.
@ -936,7 +936,7 @@ minor mode is enabled."
(defvar semantic-stickyfunc-sticky-classes
'(function type)
"List of tag classes which sticky func will display in the header line.")
"List of tag classes which stickyfunc will display in the header line.")
(make-variable-buffer-local 'semantic-stickyfunc-sticky-classes)
(defun semantic-stickyfunc-tag-to-stick ()
@ -953,7 +953,7 @@ minor mode is enabled."
(defun semantic-stickyfunc-fetch-stickyline ()
"Make the function at the top of the current window sticky.
Capture it's function declaration, and place it in the header line.
Capture its function declaration, and place it in the header line.
If there is no function, disable the header line."
(let ((str
(save-excursion
@ -962,7 +962,7 @@ If there is no function, disable the header line."
(end-of-line)
;; Capture this function
(let* ((tag (semantic-stickyfunc-tag-to-stick)))
;; TAG is nil if there was nothing of the apropriate type there.
;; TAG is nil if there was nothing of the appropriate type there.
(if (not tag)
;; Set it to be the text under the header line
(buffer-substring (point-at-bol) (point-at-eol))
@ -1080,7 +1080,7 @@ When enabled, the first line of the current tag is highlighted."
]
[ "Narrow To Tag" senator-narrow-to-defun
:active (semantic-current-tag)
:help "Narrow to the bounds of the current tag."]
:help "Narrow to the bounds of the current tag"]
[ "Fold Tag" senator-fold-tag-toggle
:active (semantic-current-tag)
:style toggle
@ -1129,7 +1129,7 @@ Use the command `semantic-highlight-func-mode' to change this variable.")
(defun semantic-highlight-func-mode-setup ()
"Setup option `semantic-highlight-func-mode'.
For semantic enabled buffers, highlight the first line of the
For Semantic enabled buffers, highlight the first line of the
current tag declaration."
(if semantic-highlight-func-mode
(progn
@ -1202,7 +1202,7 @@ function was called, move the overlay."
(setq semantic-highlight-func-ct-overlay ol)
)
;; TAG is nil if there was nothing of the apropriate type there.
;; TAG is nil if there was nothing of the appropriate type there.
(if (or (not tag) disable)
;; No tag, make the overlay go away.
(progn