diff lisp/nxml/nxml-mode.el @ 96496:e374c747704b

Fix typos, and general docstring cleanup. * nxml/nxml-glyph.el (nxml-glyph-set-hook): * nxml/nxml-uchnm.el (nxml-unicode-blocks) (nxml-unicode-block-char-name-set): * nxml/nxml-util.el (nxml-debug, nxml-make-namespace): * nxml/rng-nxml.el (rng-set-state-after): * nxml/rng-uri.el (rng-file-name-uri): Fix typo in docstring. * nxml/rng-cmpct.el (rng-c-lookup-create, rng-c-parse-primary) (rng-c-parse-annotation-body): * nxml/rng-dt.el (rng-dt-namespace-context-getter): Reflow docstrings. * nxml/nxml-mode.el (nxml, nxml-mode, nxml-after-change1) (nxml-extend-region, nxml-merge-indent-context-type, nxml-complete) (nxml-forward-balanced-item, nxml-dynamic-markup-word) (nxml-define-char-name-set, nxml-toggle-char-ref-extra-display): Fix typos in docstrings. (nxml-attribute-indent): Reflow docstring. (nxml-bind-meta-tab-to-complete-flag, nxml-last-fontify-end) (nxml-default-buffer-file-coding-system): Doc fixes. * nxml/nxml-ns.el (nxml-ns-state, nxml-ns-initial-state) (nxml-ns-set-prefix): Fix typos in docstrings. (nxml-ns-push-state, nxml-ns-pop-state, nxml-ns-set-default): Reflow docstring. (nxml-ns-get-prefix, nxml-ns-get-default): Doc fixes. * nxml/nxml-outln.el (nxml-hide-all-text-content) (nxml-show-direct-text-content, nxml-show-direct-subheadings) (nxml-hide-direct-text-content, nxml-hide-subheadings) (nxml-hide-text-content, nxml-show-subheadings, nxml-hide-other) (nxml-outline-display-rest, nxml-outline-set-overlay) (nxml-section-tag-forward, nxml-section-tag-backward) (nxml-back-to-section-start): Fix typos in docstrings. * nxml/nxml-parse.el (nxml-validate-function, nxml-parse-file): Doc fixes. * nxml/nxml-rap.el (nxml-scan-end, nxml-move-tag-backwards) (nxml-scan-element-forward, nxml-scan-element-backward): Doc fixes. (nxml-scan-after-change): Fix typo in docstring. * nxml/rng-match.el (rng-being-compiled, rng-normalize-choice-list) (rng-name-class-possible-names): Doc fixes. (rng-memo-map-add, rng-intern-group, rng-match-possible-namespace-uris) (rng-match-possible-start-tag-names, rng-match-possible-value-strings): Fix typos in docstrings. (rng-intern-group-shortcut, rng-intern-choice-shortcut): Reflow docstrings. * nxml/rng-util.el (rng-uniquify-eq, rng-uniquify-equal): Doc fixes. (rng-substq, rng-complete-before-point): Fix typos in docstrings. * nxml/rng-xsd.el (rng-xsd-make-date-time-regexp) (rng-xsd-convert-date-time): Reflow docstrings. (rng-xsd-compile): Fix typo in docstring. * nxml/rng-loc.el (rng-current-schema-file-name) (rng-locate-schema-file-using, rng-locate-schema-file-from-type-id): Doc fixes. (rng-set-schema-file): Fix typo in docstring. * nxml/rng-valid.el (rng-error-count, rng-validate-mode) (rng-do-some-validation, rng-process-start-tag, rng-process-text): Fix typos in docstrings. (rng-message-overlay, rng-conditional-up-to-date-start) (rng-conditional-up-to-date-end): Doc fixes. (rng-next-error, rng-previous-error): Reflow docstrings. * nxml/xmltok.el (xmltok-attribute-raw-normalized-value): Doc fix. (xmltok-dtd, xmltok-dependent-regions, xmltok-attribute-refs) (xmltok-valid-char-p, xmltok-standalone, xmltok-forward-prolog) (xmltok-merge-attributes): Fix typos in docstrings. (xmltok-make-attribute, xmltok-forward-special) (xmltok-get-declared-encoding-position): Reflow docstrings. * nxml/xsd-regexp.el (xsdre-char-class-to-range-list): Doc fix. (xsdre-range-list-union, xsdre-check-range-list, xsdre-current-regexp): Fix typos in docstrings.

--- a/lisp/nxml/nxml-mode.el	Wed Jul 02 16:23:35 2008 +0000
+++ b/lisp/nxml/nxml-mode.el	Thu Jul 03 12:25:23 2008 +0000
@@ -44,7 +44,7 @@
 ;;; Customization
 
 (defgroup nxml nil
-  "New XML editing mode"
+  "New XML editing mode."
   :group 'languages
   :group 'wp)
 
@@ -86,9 +86,9 @@
 
 (defcustom nxml-attribute-indent 4
   "*Indentation for the attributes of an element relative to the start-tag.
-This only applies when the first attribute of a tag starts a line. In other
-cases, the first attribute on one line is indented the same as the first
-attribute on the previous line."
+This only applies when the first attribute of a tag starts a line.
+In other cases, the first attribute on one line is indented the same
+as the first attribute on the previous line."
   :group 'nxml
   :type 'integer)
 
@@ -97,7 +97,7 @@
 C-return will be bound to `nxml-complete' in any case.
 M-TAB gets swallowed by many window systems/managers, and
 `documentation' will show M-TAB rather than C-return as the
-binding `rng-complete' when both are bound.  So it's better
+binding for `nxml-complete' when both are bound.  So it's better
 to bind M-TAB only when it will work."
   :group 'nxml
   :set (lambda (sym flag)
@@ -125,7 +125,7 @@
 
 (defcustom nxml-default-buffer-file-coding-system nil
   "*Default value for `buffer-file-coding-system' for a buffer for a new file.
-Nil means use the default value of `buffer-file-coding-system' as normal.
+A value of nil means use the default value of `buffer-file-coding-system' as normal.
 A buffer's `buffer-file-coding-system' affects what \\[nxml-insert-xml-declaration] inserts."
   :group 'nxml
   :type 'coding-system)
@@ -263,7 +263,7 @@
   '((t (:inherit nxml-delimiter)))
   "Face used for the colon in attribute names."
   :group 'nxml-faces)
-  
+
 (defface nxml-attribute-local-name
   '((t (:inherit font-lock-variable-name-face)))
   "Face used for the local name of attributes."
@@ -339,7 +339,7 @@
       :foreground
       "black"
       :weight
-      normal 
+      normal
       :slant
       normal))
     (t
@@ -348,7 +348,7 @@
       :foreground
       "black"
       :weight
-      normal 
+      normal
       :slant
       normal)))
   "Face used for glyph for char references."
@@ -363,7 +363,7 @@
 
 (defvar nxml-last-fontify-end nil
   "Position where fontification last ended.
-Nil if the buffer changed since the last fontification.")
+It is nil if the buffer changed since the last fontification.")
 (make-variable-buffer-local 'nxml-last-fontify-end)
 
 (defvar nxml-degraded nil
@@ -416,7 +416,7 @@
     (define-key map "\C-c\C-o" nxml-outline-prefix-map)
     (define-key map [S-mouse-2] 'nxml-mouse-hide-direct-text-content)
     (define-key map "/" 'nxml-electric-slash)
-    (define-key map [C-return] 'nxml-complete) 
+    (define-key map [C-return] 'nxml-complete)
     (when nxml-bind-meta-tab-to-complete-flag
       (define-key map "\M-\t" 'nxml-complete))
     map)
@@ -439,7 +439,7 @@
 
 \\[nxml-finish-element] finishes the current element by inserting an end-tag.
 C-c C-i closes a start-tag with `>' and then inserts a balancing end-tag
-leaving point between the start-tag and end-tag. 
+leaving point between the start-tag and end-tag.
 \\[nxml-balanced-close-start-tag-block] is similar but for block rather than inline elements:
 the start-tag, point, and end-tag are all left on separate lines.
 If `nxml-slash-auto-complete-flag' is non-nil, then inserting a `</'
@@ -459,8 +459,8 @@
 Validation is provided by the related minor-mode `rng-validate-mode'.
 This also makes completion schema- and context- sensitive.  Element
 names, attribute names, attribute values and namespace URIs can all be
-completed. By default, `rng-validate-mode' is automatically enabled. You
-can toggle it using \\[rng-validate-mode] or change the default by
+completed. By default, `rng-validate-mode' is automatically enabled.
+You can toggle it using \\[rng-validate-mode] or change the default by
 customizing `rng-nxml-auto-validate-flag'.
 
 \\[indent-for-tab-command] indents the current line appropriately.
@@ -468,8 +468,8 @@
 and the variable `nxml-attribute-indent'.
 
 \\[nxml-insert-named-char] inserts a character reference using
-the character's name (by default, the Unicode name). \\[universal-argument] \\[nxml-insert-named-char]
-inserts the character directly.
+the character's name (by default, the Unicode name).
+\\[universal-argument] \\[nxml-insert-named-char] inserts the character directly.
 
 The Emacs commands that normally operate on balanced expressions will
 operate on XML markup items.  Thus \\[forward-sexp] will move forward
@@ -609,10 +609,10 @@
                    start end pre-change-length)))))))))
 
 (defun nxml-after-change1 (start end pre-change-length)
-  "After-change bookkeeping.  Returns a cons cell containing a
-possibly-enlarged change region.  You must call
-nxml-extend-region on this expanded region to obtain the full
-extent of the area needing refontification.
+  "After-change bookkeeping.
+Returns a cons cell containing a possibly-enlarged change region.
+You must call `nxml-extend-region' on this expanded region to obtain
+the full extent of the area needing refontification.
 
 For bookkeeping, call this function even when fontification is
 disabled."
@@ -800,7 +800,7 @@
 	  (setq suitable-coding-systems (cdr suitable-coding-systems))))
       ret)))
 
-(defun nxml-choose-utf-coding-system ()	     
+(defun nxml-choose-utf-coding-system ()
   (let ((cur (and (local-variable-p 'buffer-file-coding-system)
 		  buffer-file-coding-system
 		  (coding-system-base buffer-file-coding-system))))
@@ -840,7 +840,7 @@
 (defvar font-lock-beg) (defvar font-lock-end)
 (defun nxml-extend-region ()
   "Extend the region to hold the minimum area we can fontify with nXML.
-Called with font-lock-beg and font-lock-end dynamically bound."
+Called with `font-lock-beg' and `font-lock-end' dynamically bound."
   (let ((start font-lock-beg)
         (end font-lock-end))
 
@@ -1278,7 +1278,7 @@
 	  (insert "\n")
 	  (indent-line-to (+ nxml-child-indent indent)))
 	(goto-char pos)))))
-	
+
 (defun nxml-finish-element ()
   "Finish the current element by inserting an end-tag."
   (interactive "*")
@@ -1480,8 +1480,8 @@
 (defun nxml-merge-indent-context-type (context)
   "Merge the indent context type CONTEXT with the token in `xmltok-type'.
 Return the merged indent context type.  An indent context type is
-either nil or one of the symbols start-tag, end-tag, markup, comment,
-mixed."
+either nil or one of the symbols `start-tag', `end-tag', `markup',
+`comment', `mixed'."
   (cond ((memq xmltok-type '(start-tag partial-start-tag))
 	 (if (memq context '(nil start-tag comment))
 	     'start-tag
@@ -1573,7 +1573,7 @@
 	     (setq atts nil))
 	    (t (setq atts (cdr atts)))))
     value-boundary))
-	     
+
 (defun nxml-compute-indent-in-delimited-token (pos open-delim close-delim)
   "Return the indent for a line that starts inside a token with delimiters.
 OPEN-DELIM and CLOSE-DELIM are strings giving the opening and closing
@@ -1604,7 +1604,7 @@
 Inserts as many characters as can be completed.  However, if not even
 one character can be completed, then a buffer with the possibilities
 is popped up and the symbol is read from the minibuffer with
-completion. If the symbol is complete, then any characters that must
+completion.  If the symbol is complete, then any characters that must
 follow the symbol are also inserted.
 
 The name space used for completion and what is treated as a symbol
@@ -1626,11 +1626,11 @@
 
 An element contains as items strings with no markup, tags, processing
 instructions, comments, CDATA sections, entity references and
-characters references. However, if the variable
+characters references.  However, if the variable
 `nxml-sexp-element-flag' is non-nil, then an element is treated as a
 single markup item.  A start-tag contains an element name followed by
-one or more attributes.  An end-tag contains just an element name.  An
-attribute value literals contains strings with no markup, entity
+one or more attributes.  An end-tag contains just an element name.
+An attribute value literals contains strings with no markup, entity
 references and character references.  A processing instruction
 consists of a target and a content string.  A comment or a CDATA
 section contains a single string.  An entity reference contains a
@@ -2130,7 +2130,7 @@
 	     (goto-char (+ xmltok-start offset))
 	     (and (re-search-forward "^[ \t]*$" end t)
 		  (match-beginning 0)))))
-	((and (memq xmltok-type '(start-tag 
+	((and (memq xmltok-type '(start-tag
 				  end-tag
 				  empty-element
 				  comment
@@ -2146,7 +2146,7 @@
 	      (looking-at "[ \t]*$")
 	      (not (nxml-in-mixed-content-p t)))
 	 (save-excursion
-	   (or (search-forward "\n" nil t) 
+	   (or (search-forward "\n" nil t)
 	       (point-max))))))
 
 (defun nxml-paragraph-start-pos (had-data offset)
@@ -2186,7 +2186,7 @@
 	   (goto-char (- (point) offset))
 	   (and (re-search-backward "^[ \t]*$" xmltok-start t)
 		(match-beginning 0))))
-	((and (memq xmltok-type '(start-tag 
+	((and (memq xmltok-type '(start-tag
 				  end-tag
 				  empty-element
 				  comment
@@ -2194,7 +2194,7 @@
 				  entity-ref))
 	      (nxml-token-ends-line-p)
 	      (nxml-token-begins-line-p))
-	 (or (search-forward "\n" nil t) 
+	 (or (search-forward "\n" nil t)
 	     (point-max)))
 	((and (eq xmltok-type 'start-tag)
 	      (nxml-token-begins-line-p)
@@ -2334,7 +2334,7 @@
       (fill-region-as-paragraph start end arg))
     (skip-line-prefix fill-prefix)
     fill-prefix))
-    
+
 (defun nxml-newline-and-indent (soft)
   (delete-horizontal-space)
   (if soft (insert-and-inherit ?\n) (newline 1))
@@ -2356,10 +2356,10 @@
 the word before point; the contents of the current buffer is used to
 decide where.
 
-It works in a similar way to \\[dabbrev-expand]. It searches first
+It works in a similar way to \\[dabbrev-expand].  It searches first
 backwards from point, then forwards from point for an element whose
 content is a string which matches the contents of the buffer before
-point and which includes at least the word before point. It then
+point and which includes at least the word before point.  It then
 copies the start- and end-tags from that element and uses them to
 surround the matching string before point.
 
@@ -2465,7 +2465,7 @@
 			      (- start-tag-close-pos xmltok-start)))
 		(insert "</" name ">")
 		(setq nxml-dynamic-markup-prev-pos (point))))))))))
-							   
+
 
 ;;; Character names
 
@@ -2494,10 +2494,10 @@
 (defvar nxml-autoload-char-name-set-list nil
   "List of char namesets that can be autoloaded.")
 
-(defun nxml-enable-char-name-set (nameset)    
+(defun nxml-enable-char-name-set (nameset)
   (put nameset 'nxml-char-name-set-enabled t))
 
-(defun nxml-disable-char-name-set (nameset)    
+(defun nxml-disable-char-name-set (nameset)
   (put nameset 'nxml-char-name-set-enabled nil))
 
 (defun nxml-char-name-set-enabled-p (nameset)
@@ -2512,9 +2512,9 @@
 (defun nxml-define-char-name-set (nameset alist)
   "Define a set of character names.
 NAMESET is a symbol identifying the set.
-Alist is a list where each member has the form (NAME CODE),
-where NAME is a string naming a character and code
-is an integer giving the Unicode scalar value of the character."
+ALIST is a list where each member has the form (NAME CODE),
+where NAME is a string naming a character and code is an
+integer giving the Unicode scalar value of the character."
   (when (get nameset 'nxml-char-name-set-defined)
     (error "Nameset `%s' already defined" nameset))
   (let ((iter alist))
@@ -2573,7 +2573,7 @@
 		      (error "Character %x is not supported by Emacs"
 			     code))
 		(format "&#x%X;" code))))))
-  
+
 (defun nxml-maybe-load-char-name-set (sym)
   (when (and (get sym 'nxml-char-name-set-enabled)
 	     (not (get sym 'nxml-char-name-set-defined))
@@ -2581,7 +2581,7 @@
     (load (get sym 'nxml-char-name-set-file))))
 
 (defun nxml-toggle-char-ref-extra-display (arg)
-  "*Toggle the display of extra information for character references."
+  "Toggle the display of extra information for character references."
   (interactive "P")
   (let ((new (if (null arg)
 		 (not nxml-char-ref-extra-display)
@@ -2619,7 +2619,7 @@
 (defun nxml-start-delimiter-length (type)
   (or (get type 'nxml-start-delimiter-length)
       0))
-			
+
 (put 'cdata-section 'nxml-start-delimiter-length 9)
 (put 'comment 'nxml-start-delimiter-length 4)
 (put 'processing-instruction 'nxml-start-delimiter-length 2)
@@ -2632,7 +2632,7 @@
 (defun nxml-end-delimiter-length (type)
   (or (get type 'nxml-end-delimiter-length)
       0))
-			
+
 (put 'cdata-section 'nxml-end-delimiter-length 3)
 (put 'comment 'nxml-end-delimiter-length 3)
 (put 'processing-instruction 'nxml-end-delimiter-length 2)