Add 2012 to FSF copyright years for Emacs files
[bpt/emacs.git] / lisp / cedet / srecode / document.el
index fd35a18..1431508 100644 (file)
@@ -1,6 +1,6 @@
 ;;; srecode/document.el --- Documentation (comment) generation
 
-;; Copyright (C) 2008, 2009 Free Software Foundation, Inc.
+;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
 
 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
 
@@ -37,7 +37,7 @@
 ;; Document has now been ported to srecode, using the semantic recoder
 ;; as the templating engine.
 
-;; This file combines srecode-document.el and srecode-document-vars.el
+;; This file combines srecode/document.el and srecode/document-vars.el
 ;; from the CEDET repository.
 
 (require 'srecode/args)
@@ -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."
@@ -122,7 +122,7 @@ RESULT is a string."
     ("read" . "Reads from")
     ("reset" . "Resets the parameters and returns")
     ("scan" . "Scans the ")
-    ("setup\\|init\\(iallize\\)?" . "Initializes the ")
+    ("setup\\|init\\(ialize\\)?" . "Initializes the ")
     ("select" . "Chooses the ")
     ("send" . "Sends a")
     ("re?c\\(v\\|ieves?\\)" . "Receives a ")
@@ -167,11 +167,11 @@ doesn't always work correctly."
     ("str\\(ing\\)?" . "string")
     ("use?r" . "user")
     ("num\\(ber\\)?" . "number")
-    ("\\(^\\|\\s-\\)id\\($\\|\\s-\\)" . "Identifier") ;complex cause ;commen sylable
+    ("\\(^\\|\\s-\\)id\\($\\|\\s-\\)" . "Identifier") ;complex cause ;common syllable
     )
   "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 @@ RESULT is a string."
 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 @@ place this comment after the parameter name."
     ("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 @@ If the cursor is on a one line prototype, then insert post-fcn comments."
 (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 @@ It is assumed that the comment occurs just in front of FCN-IN."
 (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 @@ If there is only one tag in the region, complain."
   "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)
@@ -698,7 +698,7 @@ allocating something based on its type."
                                 (cdr (car al)))))
            (setq al nil)))
       (setq al (cdr al)))
-    ;; add tailers to names which are obviously returning something.
+    ;; add trailers to names which are obviously returning something.
     (if tailit
        (progn
          (setq al srecode-document-autocomment-return-last-alist)
@@ -720,7 +720,7 @@ allocating something based on its type."
   "Convert tag or string PARAM into a name,comment pair.
 Optional COMMENTLIST is list of previously existing comments to
 use instead in alist form.  If the name doesn't appear in the list of
-standard names, then englishify it instead."
+standard names, then english it instead."
   (let ((cmt "")
        (aso srecode-document-autocomment-param-alist)
        (fnd nil)
@@ -811,8 +811,8 @@ not account for verb parts."
            (if (string-match (car (car al)) (downcase ts))
                (progn
                  (setq newstr (concat newstr (cdr (car al))))
-                 ;; don't terminate because we may actuall have 2 words
-                 ;; next to eachother we didn't identify before
+                 ;; don't terminate because we may actually have 2 words
+                 ;; next to each other we didn't identify before
                  (setq llow t)))
            (setq al (cdr al)))
          (if (not llow) (setq newstr (concat newstr ts)))
@@ -834,7 +834,6 @@ not account for verb parts."
 
 ;; Local variables:
 ;; generated-autoload-file: "loaddefs.el"
-;; generated-autoload-feature: srecode/loaddefs
 ;; generated-autoload-load-name: "srecode/document"
 ;; End: