;;; srecode/document.el --- Documentation (comment) generation
-;; Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
+;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <eric@siege-engine.com>
;; 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)
("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 ")
("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
(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)
"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)
(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)))