diff options
author | Juanma Barranquero <lekktu@gmail.com> | 2008-07-03 12:25:23 +0000 |
---|---|---|
committer | Juanma Barranquero <lekktu@gmail.com> | 2008-07-03 12:25:23 +0000 |
commit | 10545bd83d3b5c7f6082d56a59449ff1eddae2ff (patch) | |
tree | e6a516cfc9c44e80a6874a534f0e9a9908d0ba1f /lisp/nxml/nxml-rap.el | |
parent | 946598bf94b5a0fac989f3108a6ee2bc425611de (diff) | |
download | emacs-10545bd83d3b5c7f6082d56a59449ff1eddae2ff.tar.gz |
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.
Diffstat (limited to 'lisp/nxml/nxml-rap.el')
-rw-r--r-- | lisp/nxml/nxml-rap.el | 49 |
1 files changed, 25 insertions, 24 deletions
diff --git a/lisp/nxml/nxml-rap.el b/lisp/nxml/nxml-rap.el index 7d6078f1119..73991a46824 100644 --- a/lisp/nxml/nxml-rap.el +++ b/lisp/nxml/nxml-rap.el @@ -94,16 +94,16 @@ (defvar nxml-scan-end nil "Marker giving position up to which we have scanned. nxml-scan-end must be >= nxml-prolog-end. Furthermore, nxml-scan-end -must not an inside position in the following sense. A position is +must not be an inside position in the following sense. A position is inside if the following character is a part of, but not the first character of, a CDATA section, comment or processing instruction. Furthermore all positions >= nxml-prolog-end and < nxml-scan-end that -are inside positions must have a non-nil nxml-inside property whose -value is a symbol specifying what it is inside. Any characters with a -non-nil fontified property must have position < nxml-scan-end and the -correct face. Dependent regions must also be established for any +are inside positions must have a non-nil `nxml-inside' property whose +value is a symbol specifying what it is inside. Any characters with a +non-nil `fontified' property must have position < nxml-scan-end and +the correct face. Dependent regions must also be established for any unclosed constructs starting before nxml-scan-end. -There must be no nxml-inside properties after nxml-scan-end.") +There must be no `nxml-inside' properties after nxml-scan-end.") (make-variable-buffer-local 'nxml-scan-end) (defsubst nxml-get-inside (pos) @@ -139,7 +139,7 @@ Return nil if the character at POS is not inside." "Restore `nxml-scan-end' invariants after a change. The change happened between START and END. Return position after which lexical state is unchanged. -END must be > nxml-prolog-end. START must be outside +END must be > `nxml-prolog-end'. START must be outside any 'inside' regions and at the beginning of a token." (if (>= start nxml-scan-end) nxml-scan-end @@ -301,10 +301,11 @@ Sets variables like `nxml-token-after'." xmltok-type)) (defun nxml-move-tag-backwards (bound) - "Move point backwards outside any 'inside' regions or tags, up -to nxml-prolog-end. Point will either be at bound or a '<' -character starting a tag outside any 'inside' regions. Ignores -dependent regions. As a precondition, point must be >= bound." + "Move point backwards outside any 'inside' regions or tags. +Point will not move past `nxml-prolog-end'. +Point will either be at BOUND or a '<' character starting a tag +outside any 'inside' regions. Ignores dependent regions. +As a precondition, point must be >= BOUND." (nxml-move-outside-backwards) (when (not (equal (char-after) ?<)) (if (search-backward "<" bound t) @@ -353,12 +354,12 @@ Leave point unmoved if it is not inside anything special." (defun nxml-scan-element-forward (from &optional up) "Scan forward from FROM over a single balanced element. -Point must between tokens. Return the position of the end of the tag -that ends the element. `xmltok-start' will contain the position of the -start of the tag. If UP is non-nil, then scan past end-tag of element -containing point. If no element is found, return nil. If a -well-formedness error prevents scanning, signal an nxml-scan-error. -Point is not moved." +Point must be between tokens. Return the position of the end of +the tag that ends the element. `xmltok-start' will contain the +position of the start of the tag. If UP is non-nil, then scan +past end-tag of element containing point. If no element is +found, return nil. If a well-formedness error prevents scanning, +signal an `nxml-scan-error'. Point is not moved." (let ((open-tags (and up t)) found) (save-excursion @@ -404,13 +405,13 @@ expected `%s'" (defun nxml-scan-element-backward (from &optional up bound) "Scan backward from FROM over a single balanced element. -Point must between tokens. Return the position of the end of the tag -that starts the element. `xmltok-start' will contain the position of -the start of the tag. If UP is non-nil, then scan past start-tag of -element containing point. If BOUND is non-nil, then don't scan back -past BOUND. If no element is found, return nil. If a well-formedness -error prevents scanning, signal an nxml-scan-error. Point is not -moved." +Point must be between tokens. Return the position of the end of +the tag that starts the element. `xmltok-start' will contain the +position of the start of the tag. If UP is non-nil, then scan +past start-tag of element containing point. If BOUND is non-nil, +then don't scan back past BOUND. If no element is found, return +nil. If a well-formedness error prevents scanning, signal an +`nxml-scan-error'. Point is not moved." (let ((open-tags (and up t)) token-end found) (save-excursion |