From 65beee52435bba0a8789f0589978a3291f734f54 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Thu, 2 Dec 2010 19:10:25 -0800 Subject: [PATCH] Remove leading `*' from nxml defcustom docs. * lisp/nxml/nxml-mode.el, lisp/nxml/nxml-outln.el, lisp/nxml/rng-loc.el: * lisp/nxml/rng-nxml.el, lisp/nxml/rng-valid.el: Remove leading `*' from defcustom docs. --- lisp/ChangeLog | 4 ++++ lisp/nxml/nxml-mode.el | 24 ++++++++++++------------ lisp/nxml/nxml-outln.el | 10 +++++----- lisp/nxml/rng-loc.el | 6 +++--- lisp/nxml/rng-nxml.el | 8 ++++---- lisp/nxml/rng-valid.el | 12 ++++++------ 6 files changed, 34 insertions(+), 30 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index fb1246f9fd..f0ecd731fa 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,5 +1,9 @@ 2010-12-03 Glenn Morris + * nxml/nxml-mode.el, nxml/nxml-outln.el, nxml/rng-loc.el: + * nxml/rng-nxml.el, nxml/rng-valid.el: + Remove leading `*' from defcustom docs. + * startup.el (normal-top-level-add-subdirs-to-load-path): Simplify. (normal-top-level-add-to-load-path, tty-handle-args): Convert comments to basic doc-strings. diff --git a/lisp/nxml/nxml-mode.el b/lisp/nxml/nxml-mode.el index 0d75c092fd..df614741c5 100644 --- a/lisp/nxml/nxml-mode.el +++ b/lisp/nxml/nxml-mode.el @@ -1,6 +1,7 @@ ;;; nxml-mode.el --- a new XML mode -;; Copyright (C) 2003, 2004, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +;; Copyright (C) 2003, 2004, 2007, 2008, 2009, 2010 +;; Free Software Foundation, Inc. ;; Author: James Clark ;; Keywords: XML @@ -52,7 +53,7 @@ :group 'nxml) (defcustom nxml-char-ref-display-glyph-flag t - "*Non-nil means display glyph following character reference. + "Non-nil means display glyph following character reference. The glyph is displayed in face `nxml-glyph'. The hook `nxml-glyph-set-hook' can be used to customize for which characters glyphs are displayed." @@ -60,25 +61,25 @@ glyphs are displayed." :type 'boolean) (defcustom nxml-sexp-element-flag nil - "*Non-nil means sexp commands treat an element as a single expression." + "Non-nil means sexp commands treat an element as a single expression." :group 'nxml :type 'boolean) (defcustom nxml-slash-auto-complete-flag nil - "*Non-nil means typing a slash automatically completes the end-tag. + "Non-nil means typing a slash automatically completes the end-tag. This is used by `nxml-electric-slash'." :group 'nxml :type 'boolean) (defcustom nxml-child-indent 2 - "*Indentation for the children of an element relative to the start-tag. + "Indentation for the children of an element relative to the start-tag. This only applies when the line or lines containing the start-tag contains nothing else other than that start-tag." :group 'nxml :type 'integer) (defcustom nxml-attribute-indent 4 - "*Indentation for the attributes of an element relative to the start-tag. + "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." @@ -86,7 +87,7 @@ as the first attribute on the previous line." :type 'integer) (defcustom nxml-bind-meta-tab-to-complete-flag (not window-system) - "*Non-nil means bind M-TAB in `nxml-mode-map' to `nxml-complete'. + "Non-nil means bind M-TAB in `nxml-mode-map' to `nxml-complete'. 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 @@ -100,7 +101,7 @@ to bind M-TAB only when it will work." :type 'boolean) (defcustom nxml-prefer-utf-16-to-utf-8-flag nil - "*Non-nil means prefer UTF-16 to UTF-8 when saving a buffer. + "Non-nil means prefer UTF-16 to UTF-8 when saving a buffer. This is used only when a buffer does not contain an encoding declaration and when its current `buffer-file-coding-system' specifies neither UTF-16 nor UTF-8." @@ -109,7 +110,7 @@ nor UTF-8." (defcustom nxml-prefer-utf-16-little-to-big-endian-flag (eq system-type 'windows-nt) - "*Non-nil means prefer little-endian to big-endian byte-order for UTF-16. + "Non-nil means prefer little-endian to big-endian byte-order for UTF-16. This is used only for saving a buffer; when reading the byte-order is auto-detected. It may be relevant both when there is no encoding declaration and when the encoding declaration specifies `UTF-16'." @@ -117,14 +118,14 @@ and when the encoding declaration specifies `UTF-16'." :type 'boolean) (defcustom nxml-default-buffer-file-coding-system nil - "*Default value for `buffer-file-coding-system' for a buffer for a new file. + "Default value for `buffer-file-coding-system' for a buffer for a new file. 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) (defcustom nxml-auto-insert-xml-declaration-flag nil - "*Non-nil means automatically insert an XML declaration in a new file. + "Non-nil means automatically insert an XML declaration in a new file. The XML declaration is inserted using `nxml-insert-xml-declaration'." :group 'nxml :type 'boolean) @@ -2693,5 +2694,4 @@ With a prefix argument, inserts the character directly." (provide 'nxml-mode) -;; arch-tag: 8603bc5f-1ef9-4021-b223-322fb2ca708e ;;; nxml-mode.el ends here diff --git a/lisp/nxml/nxml-outln.el b/lisp/nxml/nxml-outln.el index d9c340eb22..1afc4e9e5e 100644 --- a/lisp/nxml/nxml-outln.el +++ b/lisp/nxml/nxml-outln.el @@ -1,6 +1,7 @@ ;;; nxml-outln.el --- outline support for nXML mode -;; Copyright (C) 2004, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +;; Copyright (C) 2004, 2007, 2008, 2009, 2010 +;; Free Software Foundation, Inc. ;; Author: James Clark ;; Keywords: XML @@ -82,7 +83,7 @@ (defcustom nxml-section-element-name-regexp "article\\|\\(sub\\)*section\\|chapter\\|div\\|appendix\\|part\\|preface\\|reference\\|simplesect\\|bibliography\\|bibliodiv\\|glossary\\|glossdiv" - "*Regular expression matching the name of elements used as sections. + "Regular expression matching the name of elements used as sections. An XML element is treated as a section if: - its local name (that is, the name without the prefix) matches @@ -97,7 +98,7 @@ element has a local name matching the variable :type 'regexp) (defcustom nxml-heading-element-name-regexp "title\\|head" - "*Regular expression matching the name of elements used as headings. + "Regular expression matching the name of elements used as headings. An XML element is only recognized as a heading if it occurs as or within the first child of an element that is recognized as a section. See the variable `nxml-section-element-name-regexp' for more details." @@ -105,7 +106,7 @@ See the variable `nxml-section-element-name-regexp' for more details." :type 'regexp) (defcustom nxml-outline-child-indent 2 - "*Indentation in an outline for child element relative to parent element." + "Indentation in an outline for child element relative to parent element." :group 'nxml :type 'integer) @@ -1037,5 +1038,4 @@ immediately after the section's start-tag." (provide 'nxml-outln) -;; arch-tag: 1f1b7454-e573-4cd7-a505-d9dc64eef828 ;;; nxml-outln.el ends here diff --git a/lisp/nxml/rng-loc.el b/lisp/nxml/rng-loc.el index 5ba52c3e12..35ec87a8c4 100644 --- a/lisp/nxml/rng-loc.el +++ b/lisp/nxml/rng-loc.el @@ -1,6 +1,7 @@ ;;; rng-loc.el --- locate the schema to use for validation -;; Copyright (C) 2003, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +;; Copyright (C) 2003, 2007, 2008, 2009, 2010 +;; Free Software Foundation, Inc. ;; Author: James Clark ;; Keywords: XML, RelaxNG @@ -48,7 +49,7 @@ It is nil if using a vacuous schema.") "Schema for schema locating files or nil if not yet loaded.") (defcustom rng-schema-locating-files rng-schema-locating-files-default - "*List of schema locating files." + "List of schema locating files." :type '(repeat file) :group 'relax-ng) @@ -546,5 +547,4 @@ saved to the first writable file in `rng-schema-locating-files'." (provide 'rng-loc) -;; arch-tag: 725cf968-37a2-418b-b47b-d5209871a9ab ;;; rng-loc.el ends here diff --git a/lisp/nxml/rng-nxml.el b/lisp/nxml/rng-nxml.el index 858d9206e6..96e3525410 100644 --- a/lisp/nxml/rng-nxml.el +++ b/lisp/nxml/rng-nxml.el @@ -1,6 +1,7 @@ ;;; rng-nxml.el --- make nxml-mode take advantage of rng-validate-mode -;; Copyright (C) 2003, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +;; Copyright (C) 2003, 2007, 2008, 2009, 2010 +;; Free Software Foundation, Inc. ;; Author: James Clark ;; Keywords: XML, RelaxNG @@ -35,7 +36,7 @@ (require 'rng-loc) (defcustom rng-nxml-auto-validate-flag t - "*Non-nil means automatically turn on validation with nxml-mode." + "Non-nil means automatically turn on validation with nxml-mode." :type 'boolean :group 'relax-ng) @@ -47,7 +48,7 @@ ("http://www.w3.org/2001/XMLSchema-instance" . "xsi") ("http://purl.org/dc/elements/1.1/" . "dc") ("http://purl.org/dc/terms/" . "dcterms")) - "*Alist of namespaces vs preferred prefixes." + "Alist of namespaces vs preferred prefixes." :type '(repeat (cons :tag "With" (string :tag "this namespace URI") (string :tag "use this prefix"))) @@ -591,5 +592,4 @@ set `xmltok-dtd'. Returns the position of the end of the token." (provide 'rng-nxml) -;; arch-tag: bec0d6ed-6be1-4540-9c2c-6f56e8e55d8b ;;; rng-nxml.el ends here diff --git a/lisp/nxml/rng-valid.el b/lisp/nxml/rng-valid.el index 42c741bdac..f55601b322 100644 --- a/lisp/nxml/rng-valid.el +++ b/lisp/nxml/rng-valid.el @@ -1,6 +1,7 @@ ;;; rng-valid.el --- real-time validation of XML using RELAX NG -;; Copyright (C) 2003, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +;; Copyright (C) 2003, 2007, 2008, 2009, 2010 +;; Free Software Foundation, Inc. ;; Author: James Clark ;; Keywords: XML, RelaxNG @@ -110,12 +111,12 @@ :group 'relax-ng) (defcustom rng-state-cache-distance 2000 - "*Distance in characters between each parsing and validation state cache." + "Distance in characters between each parsing and validation state cache." :type 'integer :group 'relax-ng) (defcustom rng-validate-chunk-size 8000 - "*Number of characters in a RELAX NG validation chunk. + "Number of characters in a RELAX NG validation chunk. A validation chunk will be the smallest chunk that is at least this size and ends with a tag. After validating a chunk, validation will continue only if Emacs is still idle." @@ -123,14 +124,14 @@ continue only if Emacs is still idle." :group 'relax-ng) (defcustom rng-validate-delay 1.5 - "*Time in seconds that Emacs must be idle before starting a full validation. + "Time in seconds that Emacs must be idle before starting a full validation. A full validation continues until either validation is up to date or Emacs is no longer idle." :type 'number :group 'relax-ng) (defcustom rng-validate-quick-delay 0.3 - "*Time in seconds that Emacs must be idle before starting a quick validation. + "Time in seconds that Emacs must be idle before starting a quick validation. A quick validation validates at most one chunk." :type 'number :group 'relax-ng) @@ -1464,5 +1465,4 @@ string between START and END." (provide 'rng-valid) -;; arch-tag: 7dd846d3-519d-4a6d-8107-4ff0024a60ef ;;; rng-valid.el ends here -- 2.20.1