changeset 105328:2f2bc20297c6

Doc/message fixes.
author Glenn Morris <rgm@gnu.org>
date Thu, 01 Oct 2009 03:08:03 +0000
parents dcbb3800a4e1
children fa9bcb68092e
files lisp/ChangeLog lisp/cedet/srecode/args.el lisp/cedet/srecode/compile.el lisp/cedet/srecode/dictionary.el lisp/cedet/srecode/document.el lisp/cedet/srecode/extract.el lisp/cedet/srecode/getset.el lisp/cedet/srecode/insert.el lisp/cedet/srecode/map.el lisp/cedet/srecode/semantic.el lisp/cedet/srecode/srt-mode.el lisp/cedet/srecode/srt.el lisp/cedet/srecode/table.el
diffstat 13 files changed, 57 insertions(+), 35 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ChangeLog	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/ChangeLog	Thu Oct 01 03:08:03 2009 +0000
@@ -31,6 +31,28 @@
 	* cedet/semantic.el (semantic-minimum-working-buffer-size)
 	(semantic-fetch-tags, semantic-submode-list)
 	(semantic-default-submodes):
+	* 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):
+	* cedet/srecode/semantic.el (srecode-semantic-handle-:tag)
+	(srecode-semantic-handle-:tagtype, srecode-semantic-insert-tag):
+	* cedet/srecode/map.el (srecode-current-map):
+	* cedet/srecode/insert.el (srecode-insert)
+	(srecode-insert-variable-secondname-handler, srecode-insert-method)
+	(srecode-template-inserter-point-override)
+	(srecode-insert-include-lookup):
+	* cedet/srecode/getset.el (srecode-auto-choose-class):
+	* cedet/srecode/extract.el (srecode-inserter-extract):
+	* cedet/srecode/document.el
+	(srecode-document-autocomment-return-last-alist)
+	(srecode-document-autocomment-param-type-alist)
+	(srecode-document-insert-function-comment)
+	(srecode-document-insert-variable-one-line-comment)
+	(srecode-document-function-name-comment):
+	* cedet/srecode/dictionary.el (srecode-create-dictionary)
+	(srecode-compound-toString):
+	* cedet/srecode/compile.el (srecode-flush-active-templates):
+	* cedet/srecode/args.el (srecode-semantic-handle-:blank):
 	Doc/message fixes.
 
 	* vc-cvs.el (vc-cvs-parse-entry): Be more careful with the
--- a/lisp/cedet/srecode/args.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/args.el	Thu Oct 01 03:08:03 2009 +0000
@@ -1,6 +1,6 @@
 ;;; srecode/args.el --- Provide some simple template arguments
 
-;;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+;; Copyright (C) 2007, 2008, 2009  Free Software Foundation, Inc.
 
 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
 
@@ -37,7 +37,7 @@
 (defun srecode-semantic-handle-:blank (dict)
   "Add macros into the dictionary DICT specifying blank line spacing.
 The wrapgap means make sure the first and last lines of the macro
-do not contain any text from preceeding or following text."
+do not contain any text from preceding or following text."
   ;; This won't actually get used, but it might be nice
   ;; to know about it.
   (srecode-dictionary-set-value dict "BLANK" t)
--- a/lisp/cedet/srecode/compile.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/compile.el	Thu Oct 01 03:08:03 2009 +0000
@@ -25,7 +25,7 @@
 ;; Compile a Semantic Recoder template file.
 ;;
 ;; Template files are parsed using a Semantic/Wisent parser into
-;; a tag table.  The code therin is then further parsed down using
+;; a tag table.  The code therein is then further parsed down using
 ;; a regular expression parser.
 ;;
 ;; The output are a series of EIEIO objects which represent the
@@ -85,7 +85,7 @@
 
 (defun srecode-flush-active-templates ()
   "Flush the active template storage.
-Useful if something goes wrong in SRecode, and the active tempalte
+Useful if something goes wrong in SRecode, and the active template
 stack is broken."
   (interactive)
   (if (oref srecode-template active)
--- a/lisp/cedet/srecode/dictionary.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/dictionary.el	Thu Oct 01 03:08:03 2009 +0000
@@ -21,7 +21,7 @@
 
 ;;; Commentary:
 ;;
-;; Dictionaries contain lists of names and their assocaited values.
+;; Dictionaries contain lists of names and their associated values.
 ;; These dictionaries are used to fill in macros from recoder templates.
 
 ;;; Code:
@@ -154,7 +154,7 @@
 The dictionary is initialized with variables setup for that
 buffer's table.
 If BUFFER-OR-PARENT is t, then this dictionary should not be
-assocated with a buffer or parent."
+associated with a buffer or parent."
   (save-excursion
     (let ((parent nil)
 	  (buffer nil)
@@ -418,10 +418,10 @@
   (require 'srecode/fields)
   ;; If we are not in a buffer, then this is not supported.
   (when (not (bufferp standard-output))
-    (error "FIELDS invoked while inserting template to non-buffer."))
+    (error "FIELDS invoked while inserting template to non-buffer"))
 
   (if function
-      (error "@todo: Cannot mix field insertion with functions.")
+      (error "@todo: Cannot mix field insertion with functions")
 
     ;; No function.  Perform a plain field insertion.
     ;; We know we are in a buffer, so we can perform the insertion.
--- a/lisp/cedet/srecode/document.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/document.el	Thu Oct 01 03:08:03 2009 +0000
@@ -84,7 +84,7 @@
     )
   "List of common English abbreviations or full words.
 These are nouns (as opposed to verbs) for use in creating expanded
-versions of names.This is an alist with each element of the form:
+versions of names.  This is an alist with each element of the form:
  (MATCH . RESULT)
 MATCH is a regexp to match in the type field.
 RESULT is a string."
@@ -171,7 +171,7 @@
     )
   "List of common English abbreviations or full words.
 These are nouns (as opposed to verbs) for use in creating expanded
-versions of names.This is an alist with each element of the form:
+versions of names.  This is an alist with each element of the form:
  (MATCH . RESULT)
 MATCH is a regexp to match in the type field.
 RESULT is a string."
@@ -211,7 +211,7 @@
 This is an alist with each element of the form:
  (MATCH . RESULT)
 MATCH is a regexp to match in the type field.
-RESULT is a string, which can contain %s, whih is replaced with
+RESULT is a string, which can contain %s, which is replaced with
 `match-string' 1."
   :group 'document
   :type '(repeat (cons (string :tag "Regexp")
@@ -253,7 +253,7 @@
     ("GC" . "Graphic Context")
     ("Widget" . "Widget")
     )
-  "Alist of input parameter types and strings desribing them.
+  "Alist of input parameter types and strings describing them.
 This is an alist with each element of the form:
  (MATCH . RESULT)
 MATCH is a regexp to match in the type field.
@@ -360,7 +360,7 @@
 (defun srecode-document-insert-function-comment (&optional fcn-in)
   "Insert or replace a function comment.
 FCN-IN is the Semantic tag of the function to add a comment too.
-If FCN-IN is not provied, the current tag is used instead.
+If FCN-IN is not provided, the current tag is used instead.
 It is assumed that the comment occurs just in front of FCN-IN."
   (interactive)
 
@@ -471,7 +471,7 @@
 (defun srecode-document-insert-variable-one-line-comment (&optional var-in)
   "Insert or replace a variable comment.
 VAR-IN is the Semantic tag of the function to add a comment too.
-If VAR-IN is not provied, the current tag is used instead.
+If VAR-IN is not provided, the current tag is used instead.
 It is assumed that the comment occurs just after VAR-IN."
   (interactive)
 
@@ -655,7 +655,7 @@
   "Create documentation for the function defined in TAG.
 If we can identify a verb in the list followed by some
 name part then check the return value to see if we can use that to
-finish off the sentence.  ie. any function with 'alloc' in it will be
+finish off the sentence.  That is, any function with 'alloc' in it will be
 allocating something based on its type."
   (let ((al srecode-document-autocomment-return-first-alist)
 	(dropit nil)
--- a/lisp/cedet/srecode/extract.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/extract.el	Thu Oct 01 03:08:03 2009 +0000
@@ -1,6 +1,6 @@
 ;;; srecode/extract.el --- Extract content from previously inserted macro.
 
-;; Copyright (C) 2008, 2009 Free Software Foundation, Inc.
+;; Copyright (C) 2008, 2009  Free Software Foundation, Inc.
 
 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
 
@@ -221,7 +221,7 @@
       ;; With a name, do the insertion.
       (let ((subdict (srecode-dictionary-add-section-dictionary
 		      dict (oref ins :object-name))))
-	(error "Need to implement include w/ name extractor.")
+	(error "Need to implement include w/ name extractor")
 	;; Recurse into the new template while no errors.
 	(while (condition-case nil
 		   (progn
--- a/lisp/cedet/srecode/getset.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/getset.el	Thu Oct 01 03:08:03 2009 +0000
@@ -304,7 +304,7 @@
     ))
 
 (defun srecode-auto-choose-class (point)
-  "Choose a class based on locatin of POINT."
+  "Choose a class based on location of POINT."
   (save-excursion
     (when point
       (goto-char point))
--- a/lisp/cedet/srecode/insert.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/insert.el	Thu Oct 01 03:08:03 2009 +0000
@@ -1,6 +1,6 @@
 ;;; srecode/insert --- Insert srecode templates to an output stream.
 
-;;; Copyright (C) 2005, 2007, 2008, 2009 Free Software Foundation, Inc.
+;; Copyright (C) 2005, 2007, 2008, 2009  Free Software Foundation, Inc.
 
 ;; Author: Eric M. Ludlam <zappo@gnu.org>
 
@@ -69,7 +69,7 @@
 
 ;;;###autoload
 (defun srecode-insert (template-name &rest dict-entries)
-  "Inesrt the template TEMPLATE-NAME into the current buffer at point.
+  "Insert the template TEMPLATE-NAME into the current buffer at point.
 DICT-ENTRIES are additional dictionary values to add."
   (interactive (list (srecode-read-template-name "Template Name: ")))
   (if (not (srecode-table))
@@ -424,7 +424,7 @@
 	    (let ((srecode-inserter-variable-current-dictionary dictionary))
 	      (funcall fcnpart value))
 	  ;; Else, warn.
-	  (error "Variable insertion second arg %s is not a function."
+	  (error "Variable insertion second arg %s is not a function"
 		 secondname)))
     value))
 
@@ -461,11 +461,11 @@
 	)
        ;; Dictionaries... not allowed in this style
        ((srecode-dictionary-child-p val)
-	(error "Macro %s cannot insert a dictionary.  Use section macros instead."
+	(error "Macro %s cannot insert a dictionary - use section macros instead"
 	       name))
        ;; Other stuff... convert
        (t
-	(error "Macro %s cannot insert arbitrary data." name)
+	(error "Macro %s cannot insert arbitrary data" name)
 	;;(if (and val (not (stringp val)))
 	;;    (setq val (format "%S" val))))
 	))
@@ -654,7 +654,7 @@
 	    (if (eq pad 'left)
 		(concat padchars value)
 	      (concat value padchars)))))
-    (error "Width not specified for variable/width inserter.")))
+    (error "Width not specified for variable/width inserter")))
 
 (defmethod srecode-inserter-prin-example :STATIC ((ins srecode-template-inserter-width)
 						  escape-start escape-end)
@@ -668,7 +668,7 @@
   )
 
 (defvar srecode-template-inserter-point-override nil
-  "When non-nil, the point inserter will do this functin instead.")
+  "When non-nil, the point inserter will do this function instead.")
 
 (defclass srecode-template-inserter-point (srecode-template-inserter)
   ((key :initform ?^
@@ -851,7 +851,7 @@
 	 )
     ;; If there was no template name, throw an error
     (if (not templatenamepart)
-	(error "Include macro %s needs a template name." (oref sti :object-name)))
+	(error "Include macro %s needs a template name" (oref sti :object-name)))
     ;; Find the template by name, and save it.
     (if (or (not (slot-boundp sti 'includedtemplate))
 	    (not (oref sti includedtemplate)))
--- a/lisp/cedet/srecode/map.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/map.el	Thu Oct 01 03:08:03 2009 +0000
@@ -45,7 +45,7 @@
 ;;
 
 (defvar srecode-current-map nil
-  "The current map for global SRecode templtes.")
+  "The current map for global SRecode templates.")
 
 (defcustom srecode-map-save-file (expand-file-name "~/.srecode/srecode-map")
   "The save location for SRecode's map file.
--- a/lisp/cedet/srecode/semantic.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/semantic.el	Thu Oct 01 03:08:03 2009 +0000
@@ -197,7 +197,7 @@
 ;; When a :tag argument is required, identify the current :tag,
 ;; and apply it's parts into the dictionary.
 (defun srecode-semantic-handle-:tag (dict)
-  "Add macroes into the dictionary DICT based on the current :tag."
+  "Add macros into the dictionary DICT based on the current :tag."
   ;; We have a tag, start adding "stuff" into the dictionary.
   (let ((tag (or srecode-semantic-selected-tag
 		 (srecode-semantic-tag-from-kill-ring))))
@@ -214,7 +214,7 @@
 ;; cf class 'type.  Apply those parameters to the dictionary.
 
 (defun srecode-semantic-handle-:tagtype (dict)
-  "Add macroes into the dictionary DICT based on a tag of class type at point.
+  "Add macros into the dictionary DICT based on a tag of class type at point.
 Assumes the cursor is in a tag of class type.  If not, throw an error."
   (let ((typetag (or srecode-semantic-selected-tag
 		     (semantic-current-tag-of-class 'type))))
@@ -283,7 +283,7 @@
 (defun srecode-semantic-insert-tag (tag &optional style-option
 					point-insert-fcn
 					&rest dict-entries)
-  "Insert TAG into a buffer useing srecode templates at point.
+  "Insert TAG into a buffer using srecode templates at point.
 
 Optional STYLE-OPTION is a list of minor configuration of styles,
 such as the symbol 'prototype for prototype functions, or
@@ -316,7 +316,7 @@
 
 This function returns to location in the buffer where the
 inserted tag ENDS, and will leave point inside the inserted
-text based on any occurance of a point-inserter.  Templates such
+text based on any occurrence of a point-inserter.  Templates such
 as `function' will leave point where code might be inserted."
   (srecode-load-tables-for-mode major-mode)
   (let* ((ctxt (srecode-calculate-context))
--- a/lisp/cedet/srecode/srt-mode.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/srt-mode.el	Thu Oct 01 03:08:03 2009 +0000
@@ -232,7 +232,7 @@
 
 
 (defun srecode-macro-help ()
-  "Provide help for working with macros in a tempalte."
+  "Provide help for working with macros in a template."
   (interactive)
   (let* ((root 'srecode-template-inserter)
 	 (chl (aref (class-v root) class-children))
@@ -307,7 +307,7 @@
   "Non-nil if POINT is inside a macro bounds.
 If the ESCAPE_START and END are different sequences,
 a simple search is used.  If ESCAPE_START and END are the same
-characteres, start at the beginning of the line, and find out
+characters, start at the beginning of the line, and find out
 how many occur."
   (let ((tag (semantic-current-tag))
 	(es (regexp-quote (srecode-template-get-escape-start)))
--- a/lisp/cedet/srecode/srt.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/srt.el	Thu Oct 01 03:08:03 2009 +0000
@@ -33,7 +33,7 @@
   "History for `srecode-read-variable-name'.")
 
 (defun srecode-read-variable-name (prompt &optional initial hist default)
-  "Read in the name of a declaired variable in the current SRT file.
+  "Read in the name of a declared variable in the current SRT file.
 PROMPT is the prompt to use.
 INITIAL is the initial string.
 HIST is the history value, otherwise `srecode-read-variable-name-history'
--- a/lisp/cedet/srecode/table.el	Thu Oct 01 02:50:00 2009 +0000
+++ b/lisp/cedet/srecode/table.el	Thu Oct 01 03:08:03 2009 +0000
@@ -146,7 +146,7 @@
 
 (defun srecode-mode-table-new (mode file &rest init)
   "Create a new template table for MODE in FILE.
-INIT are the initialization parametrs for the new template table."
+INIT are the initialization parameters for the new template table."
   (let* ((mt (srecode-make-mode-table mode))
 	 (old (srecode-mode-table-find mt file))
 	 (attr (file-attributes file))