diff options
| author | Luc Teirlinck | 2005-12-20 03:19:50 +0000 |
|---|---|---|
| committer | Luc Teirlinck | 2005-12-20 03:19:50 +0000 |
| commit | 3c9af4381a0032d18644abaaec6bfa749b2b7670 (patch) | |
| tree | 9104c9bcdf9c28ffd97fd568441a62123a1db0b2 | |
| parent | 0e83c4e915a445c5cb69b50a291a851461adfbdd (diff) | |
| download | emacs-3c9af4381a0032d18644abaaec6bfa749b2b7670.tar.gz emacs-3c9af4381a0032d18644abaaec6bfa749b2b7670.zip | |
(Common Keywords): Fix Texinfo usage.
(Group Definitions, Variable Definitions): Update for new conventions
for using `*' in docstrings.
| -rw-r--r-- | lispref/customize.texi | 14 |
1 files changed, 5 insertions, 9 deletions
diff --git a/lispref/customize.texi b/lispref/customize.texi index 1170a909118..53a52673e39 100644 --- a/lispref/customize.texi +++ b/lispref/customize.texi | |||
| @@ -76,7 +76,7 @@ in the customization buffer with the Info node name. | |||
| 76 | Link to a web page; @var{url} is a string which specifies the | 76 | Link to a web page; @var{url} is a string which specifies the |
| 77 | @acronym{URL}. The link appears in the customization buffer as | 77 | @acronym{URL}. The link appears in the customization buffer as |
| 78 | @var{url} and invokes the WWW browser specified by | 78 | @var{url} and invokes the WWW browser specified by |
| 79 | @var{browse-url-browser-function}. | 79 | @code{browse-url-browser-function}. |
| 80 | 80 | ||
| 81 | @item (emacs-commentary-link @var{library}) | 81 | @item (emacs-commentary-link @var{library}) |
| 82 | Link to the commentary section of a library; @var{library} is a string | 82 | Link to the commentary section of a library; @var{library} is a string |
| @@ -155,8 +155,7 @@ keyword. | |||
| 155 | @defmac defgroup group members doc [keyword value]@dots{} | 155 | @defmac defgroup group members doc [keyword value]@dots{} |
| 156 | Declare @var{group} as a customization group containing @var{members}. | 156 | Declare @var{group} as a customization group containing @var{members}. |
| 157 | Do not quote the symbol @var{group}. The argument @var{doc} specifies | 157 | Do not quote the symbol @var{group}. The argument @var{doc} specifies |
| 158 | the documentation string for the group. It should not start with a | 158 | the documentation string for the group. |
| 159 | @samp{*} as in @code{defcustom}; that convention is for variables only. | ||
| 160 | 159 | ||
| 161 | The argument @var{members} is a list specifying an initial set of | 160 | The argument @var{members} is a list specifying an initial set of |
| 162 | customization items to be members of the group. However, most often | 161 | customization items to be members of the group. However, most often |
| @@ -211,12 +210,9 @@ turn this feature back on, if someone would like to do the work. | |||
| 211 | @defmac defcustom option default doc [keyword value]@dots{} | 210 | @defmac defcustom option default doc [keyword value]@dots{} |
| 212 | Declare @var{option} as a customizable user option variable. Do not | 211 | Declare @var{option} as a customizable user option variable. Do not |
| 213 | quote @var{option}. The argument @var{doc} specifies the documentation | 212 | quote @var{option}. The argument @var{doc} specifies the documentation |
| 214 | string for the variable. It should often start with a @samp{*} to mark | 213 | string for the variable. There is no need to start it with a @samp{*} |
| 215 | it as a @dfn{user option} (@pxref{Defining Variables}). Do not start | 214 | because @code{defcustom} automatically marks @var{option} as a |
| 216 | the documentation string with @samp{*} for options which cannot or | 215 | @dfn{user option} (@pxref{Defining Variables}). |
| 217 | normally should not be set with @code{set-variable}; examples of the | ||
| 218 | former are global minor mode options such as | ||
| 219 | @code{global-font-lock-mode} and examples of the latter are hooks. | ||
| 220 | 216 | ||
| 221 | If @var{option} is void, @code{defcustom} initializes it to | 217 | If @var{option} is void, @code{defcustom} initializes it to |
| 222 | @var{default}. @var{default} should be an expression to compute the | 218 | @var{default}. @var{default} should be an expression to compute the |