Commit 9bf6c65c authored by Glenn Morris's avatar Glenn Morris
Browse files

Doc/message fixes.

parent 2551831f
......@@ -54,6 +54,78 @@
* cedet/ede/cpp-root.el (initialize-instance):
* cedet/ede/autoconf-edit.el (autoconf-find-last-macro)
(autoconf-parameter-strip, autoconf-insert-new-macro):
* cedet/semantic/wisent.el (wisent-lex-eoi):
* cedet/semantic/util-modes.el (global-semantic-show-parser-state-mode)
(semantic-show-parser-state-mode):
* cedet/semantic/texi.el (semantic-texi-environment-regexp):
* cedet/semantic/tag.el (semantic-tag-new-variable)
(semantic-tag-class, semantic-tag-new-variable, semantic-tag-copy)
(semantic--tag-deep-copy-attributes, semantic--tag-deep-copy-value)
(semantic--tag-deep-copy-tag-list)
(semantic-tag-components-with-overlays-default):
* cedet/semantic/symref.el (semantic-symref-find-text):
* cedet/semantic/senator.el (senator-yank-tag)
(senator-transpose-tags-up):
* cedet/semantic/scope.el (semantic-analyze-scoped-tags-default)
(semantic-analyze-scoped-inherited-tags, semantic-scope-find):
* cedet/semantic/sb.el (semantic-sb-autoexpand-length):
* cedet/semantic/lex.el (semantic-lex-comment-regex)
(semantic-lex-maximum-depth, define-lex, semantic-lex-token)
(semantic-lex-unterminated-syntax-protection, define-lex-analyzer):
* cedet/semantic/lex-spp.el
(semantic-lex-spp-dynamic-macro-symbol-obarray-stack)
(semantic-lex-spp-symbol, semantic-lex-spp-one-token-to-txt):
* cedet/semantic/idle.el
(semantic-idle-summary-current-symbol-info-brutish)
(semantic-idle-summary-current-symbol-info-default):
* cedet/semantic/grammar.el (semantic-grammar-recreate-package)
(semantic--grammar-macro-compl-dict):
* cedet/semantic/grammar-wy.el (semantic-grammar-wy--parse-table):
* cedet/semantic/format.el (semantic-format-tag-custom-list)
(semantic-format-tag-canonical-name-default):
* cedet/semantic/find.el (semantic-find-tag-by-overlay-in-region)
(semantic-find-tags-for-completion)
(semantic-find-tags-by-scope-protection-default)
(semantic-deep-find-tags-for-completion):
* cedet/semantic/edit.el
(semantic-edits-incremental-reparse-failed-hook)
(semantic-edits-verbose-flag, semantic-edits-assert-valid-region)
(semantic-edits-splice-remove, semantic-edits-splice-replace):
* cedet/semantic/doc.el (semantic-documentation-comment-preceeding-tag):
* cedet/semantic/dep.el (semantic-dependency-include-path):
* cedet/semantic/db.el (semanticdb-default-find-index-class)
(semanticdb-match-any-mode, semanticdb-with-match-any-mode)
(semanticdb-project-roots):
* cedet/semantic/db-find.el (semanticdb-implied-include-tags)
(semanticdb-find-adebug-insert-scanned-tag-cons)
(semanticdb-find-log-buffer-name, semanticdb-find-result-mapc)
(semanticdb-brute-deep-find-tags-for-completion):
* cedet/semantic/db-ebrowse.el (semanticdb-ebrowse-add-tree-to-table):
* cedet/semantic/ctxt.el (semantic-beginning-of-context-default)
(semantic-end-of-context-default)
(semantic-ctxt-current-function-default)
(semantic-ctxt-scoped-types-default):
* cedet/semantic/complete.el (semantic-complete-read-tag-engine)
(semantic-complete-inline-tag-engine)
(semantic-complete-inline-custom-type)
(semantic-complete-read-tag-analyzer):
* cedet/semantic/chart.el (semantic-chart-tags-by-class)
(semantic-chart-database-size):
* cedet/semantic/analyze.el (semantic-analyze-current-symbol)
(semantic-analyze-current-context):
* cedet/semantic/symref/list.el (semantic-symref)
(semantic-symref-hide-buffer, semantic-symref-symbol):
* cedet/semantic/symref/grep.el (semantic-symref-grep-use-template):
* cedet/semantic/symref/filter.el (semantic-symref-hits-in-region):
* cedet/semantic/bovine/el.el (semantic-elisp-form-to-doc-string):
* cedet/semantic/bovine/c.el (semantic-lex-c-preprocessor-symbol-map)
(semantic-c-parse-token-hack-depth, semantic-c--template-name-1)
(semantic-c-dereference-template):
* cedet/semantic/analyze/refs.el (semantic--analyze-refs-full-lookup)
(semantic--analyze-refs-full-lookup-with-parents)
(semantic--analyze-refs-full-lookup-simple):
* cedet/semantic/analyze/complete.el
(semantic-analyze-possible-completions):
* cedet/srecode/table.el (srecode-mode-table-new):
* cedet/srecode/srt.el (srecode-read-variable-name):
* cedet/srecode/srt-mode.el (srecode-macro-help, srecode-in-macro-p):
......
;;; semantic/analyze.el --- Analyze semantic tags against local context
;;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009
;;; Free Software Foundation, Inc.
;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009
;; Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
......@@ -414,7 +414,7 @@ to calculate the context information. The purpose for this function is
to provide a large number of non-cached analysis for filtering symbols."
;; Only do this in a Semantic enabled buffer.
(when (not (semantic-active-p))
(error "Cannot analyze buffers not supported by Semantic."))
(error "Cannot analyze buffers not supported by Semantic"))
;; Always refresh out tags in a safe way before doing the
;; context.
(semantic-refresh-tags-safe)
......@@ -482,7 +482,7 @@ if a cached copy of the return object is found."
(interactive "d")
;; Only do this in a Semantic enabled buffer.
(when (not (semantic-active-p))
(error "Cannot analyze buffers not supported by Semantic."))
(error "Cannot analyze buffers not supported by Semantic"))
;; Always refresh out tags in a safe way before doing the
;; context.
(semantic-refresh-tags-safe)
......
;;; semantic/analyze/complete.el --- Smart Completions
;;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
......@@ -21,7 +21,7 @@
;;; Commentary:
;;
;; Caclulate smart completions.
;; Calculate smart completions.
;;
;; Uses the analyzer context routine to determine the best possible
;; list of completions.
......@@ -88,7 +88,7 @@ in a buffer."
context
(semantic-analyze-current-context context)))
(ans (if (not context)
(error "Nothing to Complete.")
(error "Nothing to complete")
(:override))))
;; If interactive, display them.
(when (interactive-p)
......
......@@ -140,7 +140,7 @@ Optional argument IN-BUFFER indicates that the returned tag should be in an acti
;;; LOOKUP
;;
(defun semantic--analyze-refs-full-lookup (tag scope)
"Perform a full lookup for all occurances of TAG in the current project.
"Perform a full lookup for all occurrences of TAG in the current project.
TAG should be the tag currently under point.
PARENT is the list of tags that are parents to TAG by
containment, as opposed to reference."
......@@ -195,7 +195,7 @@ PARENTS is a list of names."
ans))
(defun semantic--analyze-refs-full-lookup-with-parents (tag scope)
"Perform a lookup for all occurances of TAG based on TAG's SCOPE.
"Perform a lookup for all occurrences of TAG based on TAG's SCOPE.
TAG should be the tag currently under point."
(let* ((classmatch (semantic-tag-class tag))
(plist (mapcar (lambda (T) (semantic-tag-name T)) (oref scope parents)))
......@@ -242,7 +242,7 @@ TAG should be the tag currently under point."
answer))
(defun semantic--analyze-refs-full-lookup-simple (tag &optional noerror)
"Perform a simple lookup for occurances of TAG in the current project.
"Perform a simple lookup for occurrences of TAG in the current project.
TAG should be the tag currently under point.
Optional NOERROR means don't throw errors on failure to find something.
This only compares the tag name, and does not infer any matches in namespaces,
......
;;; semantic/bovine/c.el --- Semantic details for C
;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
;;; 2007, 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
;; 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
......@@ -168,7 +168,7 @@ lexical analyzer, such as `symbol' or `string'. The string in the
second position is the text that makes up the replacement. This is
the way to have multiple lexical symbols in a replacement. Using the
first way to specify text like \"foo::bar\" would not work, because :
is a sepearate lexical symbol.
is a separate lexical symbol.
A quick way to see what you would need to insert is to place a
definition such as:
......@@ -682,7 +682,7 @@ as for the parent."
))
(defvar semantic-c-parse-token-hack-depth 0
"Current depth of recursive calls to `semantic-c-parse-lexical-token'")
"Current depth of recursive calls to `semantic-c-parse-lexical-token'.")
(defun semantic-c-parse-lexical-token (lexicaltoken nonterminal depth
returnonerror)
......@@ -1284,8 +1284,8 @@ SPEC-LIST is the template specifier of the datatype instantiated."
(semantic-c--instantiate-template tag (cdr def-list) (cdr spec-list))))
(defun semantic-c--template-name-1 (spec-list)
"return a string used to compute template class name based on SPEC-LIST
for ref<Foo,Bar> it will return 'Foo,Bar'."
"Return a string used to compute template class name.
Based on SPEC-LIST, for ref<Foo,Bar> it will return 'Foo,Bar'."
(when (car spec-list)
(let* ((endpart (semantic-c--template-name-1 (cdr spec-list)))
(separator (and endpart ",")))
......@@ -1299,7 +1299,7 @@ return 'ref<Foo,Bar>'."
"<" (semantic-c--template-name-1 (cdr spec-list)) ">"))
(defun semantic-c-dereference-template (type scope &optional type-declaration)
"Dereference any template specifieres in TYPE within SCOPE.
"Dereference any template specifiers in TYPE within SCOPE.
If TYPE is a template, return a TYPE copy with the templates types
instantiated as specified in TYPE-DECLARATION."
(when (semantic-tag-p type-declaration)
......
;;; semantic/bovine/el.el --- Semantic details for Emacs Lisp
;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007,
;;; 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008,
;; 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
......@@ -140,7 +140,7 @@ syntax as specified by the syntax table."
(defun semantic-elisp-form-to-doc-string (form)
"After reading a form FORM, covert it to a doc string.
For Emacs Lisp, sometimes that string is non-existant.
For Emacs Lisp, sometimes that string is non-existent.
Sometimes it is a form which is evaluated at compile time, permitting
compound strings."
(cond ((stringp form) form)
......
;;; semantic/chart.el --- Utilities for use with semantic tag tables
;;; Copyright (C) 1999, 2000, 2001, 2003, 2005, 2008, 2009
;;; Free Software Foundation, Inc.
;; Copyright (C) 1999, 2000, 2001, 2003, 2005, 2008, 2009
;; Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
......@@ -40,7 +40,7 @@
Each bar represents how many toplevel tags in TAGTABLE
exist with a given class. See `semantic-symbol->name-assoc-list'
for tokens which will be charted.
TAGTABLE is passedto `semantic-something-to-tag-table'."
TAGTABLE is passed to `semantic-something-to-tag-table'."
(interactive)
(let* ((stream (semantic-something-to-tag-table
(or tagtable (current-buffer))))
......@@ -108,7 +108,7 @@ TAGTABLE is passed to `semantic-something-to-tag-table'."
"Create a bar chart representing the complexity of some tags.
Complexity is calculated for tags of CLASS. Each bar represents
the complexity of some tag in TAGTABLE. Only the most complex
items are charted. TAGTABLE is passedto
items are charted. TAGTABLE is passed to
`semantic-something-to-tag-table'."
(interactive)
(let* ((sym (if (not class) 'function))
......
;;; semantic/complete.el --- Routines for performing tag completion
;;; Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009
;;; Free Software Foundation, Inc.
;; Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009
;; Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: syntax
......@@ -36,7 +36,7 @@
;; quickly without resorting to "show me every possible option now".
;;
;; In addition, some symbol names will appear in multiple locations.
;; If it is important to distiguish, then a way to provide a choice
;; If it is important to distinguish, then a way to provide a choice
;; over these locations is important as well.
;;
;; Beyond brute force offers for completion of plain strings,
......@@ -55,7 +55,7 @@
;;
;; Here, we will treat each section separately (excluding D)
;; They can then be strung together in user-visible commands to
;; fullfill specific needs.
;; fulfil specific needs.
;;
;; COLLECTORS:
;;
......@@ -194,7 +194,7 @@ Keeps STRINGS only in the history.")
Argument COLLECTOR is an object which can be used to to calculate
a list of possible hits. See `semantic-completion-collector-engine'
for details on COLLECTOR.
Argumeng DISPLAYOR is an object used to display a list of possible
Argument DISPLAYOR is an object used to display a list of possible
completions for a given prefix. See`semantic-completion-display-engine'
for details on DISPLAYOR.
PROMPT is a string to prompt with.
......@@ -736,7 +736,7 @@ DO NOT CALL THIS IF THE INLINE COMPLETION ENGINE IS NOT ACTIVE."
Argument COLLECTOR is an object which can be used to to calculate
a list of possible hits. See `semantic-completion-collector-engine'
for details on COLLECTOR.
Argumeng DISPLAYOR is an object used to display a list of possible
Argument DISPLAYOR is an object used to display a list of possible
completions for a given prefix. See`semantic-completion-display-engine'
for details on DISPLAYOR.
BUFFER is the buffer in which completion will take place.
......@@ -1766,7 +1766,7 @@ completion text in ghost text."
C)))
(eieio-build-class-alist semantic-displayor-abstract t))
)
"Possible options for inlince completion displayors.
"Possible options for inline completion displayors.
Use this to enable custom editing.")
(defcustom semantic-complete-inline-analyzer-displayor-class
......@@ -1879,7 +1879,7 @@ to generate the list of possible completions.
PROMPT is the first part of the prompt. Additional prompt
is added based on the contexts full prefix.
CONTEXT is the semantic analyzer context to start with.
HISTORY is a symbol representing a variable to stor the history in.
HISTORY is a symbol representing a variable to store the history in.
usually a default-tag and initial-input are available for completion
prompts. these are calculated from the CONTEXT variable passed in."
(if (not context) (setq context (semantic-analyze-current-context (point))))
......
;;; semantic/ctxt.el --- Context calculations for Semantic tools.
;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
;;; 2007, 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
;; 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: syntax
......@@ -86,7 +86,7 @@ Return non-nil if there is no upper context.
The default behavior uses `semantic-up-context'.")
(defun semantic-beginning-of-context-default (&optional point)
"Move POINT to the beginning of the current context via parenthisis.
"Move POINT to the beginning of the current context via parenthesis.
Return non-nil if there is no upper context."
(if point (goto-char point))
(if (semantic-up-context)
......@@ -101,7 +101,7 @@ Be default, this uses `semantic-up-context', and assumes parenthetical
block delimiters.")
(defun semantic-end-of-context-default (&optional point)
"Move POINT to the end of the current context via parenthisis.
"Move POINT to the end of the current context via parenthesis.
Return non-nil if there is no upper context."
(if point (goto-char point))
(let ((start (point)))
......@@ -510,7 +510,7 @@ cursor is on the text representing that function.")
(defun semantic-ctxt-current-function-default (&optional point)
"Return the current function call the cursor is in at POINT.
The call will be identifed for C like langauges with the form
The call will be identified for C like languages with the form
NAME ( args ... )"
(if point (goto-char point))
(let ((case-fold-search semantic-case-fold))
......@@ -602,7 +602,7 @@ that may or may not have a name.)")
(defun semantic-ctxt-scoped-types-default (&optional point)
"Return a list of scoped types by name for the current context at POINT.
This is very different for various languages, and does nothing unless
overriden."
overridden."
(if point (goto-char point))
(let ((case-fold-search semantic-case-fold))
;; We need to look at TYPES within the bounds of locally parse arguments.
......
;;; semantic/db-ebrowse.el --- Semanticdb backend using ebrowse.
;;; Copyright (C) 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 2005, 2006, 2007, 2008, 2009
;; Free Software Foundation, Inc.
;; Authors: Eric M. Ludlam <zappo@gnu.org>
;; Joakim Verona
......@@ -403,7 +404,7 @@ If there is no database for DIRECTORY available, then
(defun semanticdb-ebrowse-add-tree-to-table (dbe tree &optional fname baseclasses)
"For database DBE, add the ebrowse TREE into the table for FNAME.
Optional argument BASECLASSES specifyies a baseclass to the tree being provided."
Optional argument BASECLASSES specifies a baseclass to the tree being provided."
(if (not (ebrowse-ts-p tree))
(signal 'wrong-type-argument (list 'ebrowse-ts-p tree)))
......
;;; semantic/db-find.el --- Searching through semantic databases.
;;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
;;; 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
;; 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: tags
......@@ -103,7 +103,7 @@
;; eldoc - popup help
;; => Requires basic search using default path. (Header files ok)
;; tag jump - jump to a named tag
;; => Requires a brute search useing whole project. (Source files only)
;; => Requires a brute search using whole project. (Source files only)
;; completion - Completing symbol names in a smart way
;; => Basic search (headers ok)
;; type analysis - finding type definitions for variables & fcns
......@@ -440,7 +440,7 @@ and TAG is a clone of the include tag that was found.")
Set this variable with `defvar-mode-local' for a particular mode so
that any symbols that exist for all files for that mode are included.
Note: This could be used as a way to write a file in a langauge
Note: This could be used as a way to write a file in a language
to declare all the built-ins for that language.")
(defun semanticdb-find-translate-path-includes--internal (path)
......@@ -781,7 +781,7 @@ Examines the variable `semanticdb-find-lost-includes'."
(defun semanticdb-find-adebug-insert-scanned-tag-cons (consdata prefix prebuttontext)
"Insert a button representing scanned include CONSDATA.
PREFIX is the text that preceeds the button.
PREFIX is the text that precedes the button.
PREBUTTONTEXT is some text between prefix and the overlay button."
(let* ((start (point))
(end nil)
......@@ -1019,7 +1019,7 @@ is still made current."
(defun semanticdb-find-result-mapc (fcn result)
"Apply FCN to each element of find RESULT for side-effects only.
FCN takes two arguments. The first is a TAG, and the
second is a DB from wence TAG originated.
second is a DB from whence TAG originated.
Returns result."
(mapc (lambda (sublst)
(mapc (lambda (tag)
......@@ -1038,7 +1038,7 @@ Returns result."
"The name of the logging buffer.")
(defun semanticdb-find-toggle-logging ()
"Toggle sematnicdb logging."
"Toggle semanticdb logging."
(interactive)
(setq semanticdb-find-log-flag (null semanticdb-find-log-flag))
(message "Semanticdb find logging is %sabled"
......@@ -1239,7 +1239,7 @@ associated with that tag should be loaded into a buffer."
See `semanticdb-find-translate-path' for details on PATH.
The argument BRUTISH will be set so that searching includes all tables
in the current project.
FIND-FILE-MATCH indicates that any time a matchi is found, the file
FIND-FILE-MATCH indicates that any time a match is found, the file
associated wit that tag should be loaded into a buffer."
(semanticdb-find-tags-collector
(lambda (table tags)
......@@ -1251,7 +1251,7 @@ associated wit that tag should be loaded into a buffer."
See `semanticdb-find-translate-path' for details on PATH.
The argument BRUTISH will be set so that searching includes all tables
in the current project.
FIND-FILE-MATCH indicates that any time a matchi is found, the file
FIND-FILE-MATCH indicates that any time a match is found, the file
associated wit that tag should be loaded into a buffer."
(semanticdb-find-tags-collector
(lambda (table tags)
......
;;; semantic/db.el --- Semantic tag database manager
;;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
;;; 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
;; 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: tags
......@@ -53,7 +53,7 @@ mechanism.")
(defvar semanticdb-default-find-index-class 'semanticdb-find-search-index
"The default type of search index to use for a `semanticdb-table's.
This can be changed to try out new types of search indicies.")
This can be changed to try out new types of search indices.")
(make-variable-buffer-local 'semanticdb-default-find=index-class)
;;;###autoload
......@@ -709,14 +709,14 @@ Uses `semanticdb-persistent-path' to determine the return value."
nil))
(defvar semanticdb-match-any-mode nil
"Non-nil to temporarilly search any major mode for a tag.
"Non-nil to temporarily search any major mode for a tag.
If a particular major mode wants to search any mode, put the
`semantic-match-any-mode' symbol onto the symbol of that major mode.
Do not set the value of this variable permanently.")
(defmacro semanticdb-with-match-any-mode (&rest body)
"A Semanticdb search occuring withing BODY will search tags in all modes.
This temporarilly sets `semanticdb-match-any-mode' while executing BODY."
"A Semanticdb search occurring withing BODY will search tags in all modes.
This temporarily sets `semanticdb-match-any-mode' while executing BODY."
`(let ((semanticdb-match-any-mode t))
,@body))
(put 'semanticdb-with-match-any-mode 'lisp-indent-function 0)
......@@ -764,7 +764,7 @@ local variable."
(defcustom semanticdb-project-roots nil
"*List of directories, where each directory is the root of some project.
All subdirectories of a root project are considered a part of one project.
Values in this string can be overriden by project management programs
Values in this string can be overridden by project management programs
via the `semanticdb-project-root-functions' variable."
:group 'semanticdb
:type '(repeat string))
......
;;; semantic/dep.el --- Methods for tracking dependencies (include files)
;;; Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: syntax
......@@ -30,7 +30,7 @@
;; EDE or even ECB can control our project dependencies, and help us
;; find file within the setting of a given project. For system
;; dependencies, we need to depend on user supplied lists, which can
;; manifest themselves in the form of system datatabases (from
;; manifest themselves in the form of system databases (from
;; semanticdb.)
;;
;; Provide ways to track these different files here.
......@@ -47,7 +47,7 @@ to the file being included.
If `semantic-dependency-tag-file' is overridden for a given
language, this path is most likely ignored.
The above function, reguardless of being overriden, caches the
The above function, regardless of being overridden, caches the
located dependency file location in the tag property
`dependency-file'. If you override this function, you do not
need to implement your own cache. Each time the buffer is fully
......
;;; semantic/doc.el --- Routines for documentation strings
;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009
;;; Free Software Foundation, Inc.
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2008, 2009
;; Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: syntax
......@@ -23,7 +23,7 @@
;;; Commentary:
;;
;; It is good practice to write documenation for your functions and
;; It is good practice to write documentation for your functions and
;; variables. These core routines deal with these documentation
;; comments or strings. They can exist either as a tag property
;; (:documentation) or as a comment just before the symbol, or after
......@@ -61,10 +61,11 @@ If nosnarf if 'lex, then only return the lex token."
;; Not sure yet. Fill in something clever later....
nil))))))
;; FIXME this is not how you spell "preceding".
(defun semantic-documentation-comment-preceeding-tag (&optional tag nosnarf)
"Find a comment preceeding TAG.
"Find a comment preceding TAG.
If TAG is nil. use the tag under point.
Searches the space between TAG and the preceeding tag for a comment,
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
just the lexical token and not the string."
......
;;; semantic/edit.el --- Edit Management for Semantic
;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
;;; 2007, 2008, 2009 Free Software Foundation, Inc.
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
;; 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
......@@ -54,7 +54,7 @@
;; syntax instead.
;;
;; 2. Incremental parsing while a new function is being typed in
;; somtimes gets a chance only when lists are incomplete,
;; sometimes gets a chance only when lists are incomplete,
;; preventing correct context identification.
;;
......@@ -114,13 +114,13 @@ incremental reparse.")
(defvar semantic-edits-incremental-reparse-failed-hook nil
"Hook run after the incremental parser fails.
When this happens, the buffer is marked as needing a full reprase.")
When this happens, the buffer is marked as needing a full reparse.")
(semantic-varalias-obsolete 'semantic-edits-incremental-reparse-failed-hooks
'semantic-edits-incremental-reparse-failed-hook)
(defcustom semantic-edits-verbose-flag nil
"Non-nil means the incremental perser is verbose.
"Non-nil means the incremental parser is verbose.
If nil, errors are still displayed, but informative messages are not."
:group 'semantic
:type 'boolean)
......@@ -499,7 +499,7 @@ the semantic cache to see what needs to be changed."
changed-tags))
(defmacro semantic-edits-assert-valid-region ()
"Asert that parse-start and parse-end are sorted correctly."
"Assert that parse-start and parse-end are sorted correctly."
;;; (if (> parse-start parse-end)
;;; (error "Bug is %s !> %d! Buff min/max = [ %d %d ]"
;;; parse-start parse-end
......@@ -838,7 +838,7 @@ This function is for internal use by `semantic-edits-incremental-parser'."
;; list can be fiddled.
(defun semantic-edits-splice-remove (oldtags parent cachelist)
"Remove OLDTAGS from PARENT's CACHELIST.
OLDTAGS are tags in the currenet buffer, preferably linked
OLDTAGS are tags in the current buffer, preferably linked
together also in CACHELIST.
PARENT is the parent tag containing OLDTAGS.
CACHELIST should be the children from PARENT, but may be
......@@ -931,7 +931,7 @@ convenient location, so use that."
(defun semantic-edits-splice-replace (oldtag newtag)
"Replace OLDTAG with NEWTAG in the current cache.
Do this by recycling OLDTAG's first CONS cell. This effectivly
Do this by recycling OLDTAG's first CONS cell. This effectively
causes the new tag to completely replace the old one.
Make sure that all information in the overlay is transferred.
It is presumed that OLDTAG and NEWTAG are both cooked.
......
;;; semantic/find.el --- Search routines for Semantic
;;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2008, 2009
;;; Free Software Foundation, Inc.
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2008, 2009
;; Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: syntax
......@@ -32,11 +32,11 @@
;; used for compatibility with the semantic 1.x search routines.
;;
;; 1.5) semantic-brute-find-first-tag-by-*
;; Like 1, except seraching stops on the first match for the given
;; Like 1, except searching stops on the first match for the given
;; information.
;;
;; 2) semantic-find-tag-by-*
;; These prefered search routines attempt to scan through lists
;; These preferred search routines attempt to scan through lists
;; in an intelligent way based on questions asked.
;;
;; 3) semantic-find-*-overlay
......@@ -86,7 +86,7 @@ from largest to smallest via the start location."
;;;###autoload
(defun semantic-find-tag-by-overlay-in-region (start end &optional buffer)
"Find all tags which exist in whole or in part between START and END.
Uses overlays to determine positin.
Uses overlays to determine position.