]> code.delx.au - gnu-emacs/blobdiff - lisp/progmodes/cap-words.el
Update copyright year to 2014 by running admin/update-copyright.
[gnu-emacs] / lisp / progmodes / cap-words.el
index 8a3a9c11e304f6d720ab4896e3263780d93c856e..b03daf4cd5a4cf6ae645e63fe2e25cfec86394f1 100644 (file)
@@ -1,25 +1,24 @@
 ;;; cap-words.el --- minor mode for motion in CapitalizedWordIdentifiers
 
-;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
-;;   Free Software Foundation, Inc.
+;; Copyright (C) 2002-2014 Free Software Foundation, Inc.
 
 ;; Author: Dave Love <fx@gnu.org>
 ;; Keywords: languages
 
-;; This file is free software; you can redistribute it and/or modify
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
-;; This file is distributed in the hope that it will be useful,
+;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -60,10 +59,14 @@ Looks for word boundaries before capitals."
 
 ;;;###autoload
 (define-minor-mode capitalized-words-mode
-  "Toggle Capitalized- Words mode.
-
-In this minor mode, a word boundary occurs immediately before an
-uppercase letter in a symbol.  This is in addition to all the normal
+  "Toggle Capitalized Words mode.
+With a prefix argument ARG, enable Capitalized Words mode if ARG
+is positive, and disable it otherwise.  If called from Lisp,
+enable the mode if ARG is omitted or nil.
+
+Capitalized Words mode is a buffer-local minor mode.  When
+enabled, a word boundary occurs immediately before an uppercase
+letter in a symbol.  This is in addition to all the normal
 boundaries given by the syntax and category tables.  There is no
 restriction to ASCII.
 
@@ -74,13 +77,13 @@ E.g. the beginning of words in the following identifier are as marked:
 
 Note that these word boundaries only apply for word motion and
 marking commands such as \\[forward-word].  This mode does not affect word
-boundaries in found by regexp matching (`\\>', `\\w' &c).
+boundaries found by regexp matching (`\\>', `\\w' &c).
 
 This style of identifiers is common in environments like Java ones,
 where underscores aren't trendy enough.  Capitalization rules are
 sometimes part of the language, e.g. Haskell, which may thus encourage
 such a style.  It is appropriate to add `capitalized-words-mode' to
-the mode hook for programming langauge modes in which you encounter
+the mode hook for programming language modes in which you encounter
 variables like this, e.g. `java-mode-hook'.  It's unlikely to cause
 trouble if such identifiers aren't used.
 
@@ -92,5 +95,4 @@ Obsoletes `c-forward-into-nomenclature'."
 
 (provide 'cap-words)
 
-;;; arch-tag: 46513b64-fe5a-4c0b-902c-ed235c22975f
 ;;; cap-words.el ends here