diff options
| author | Richard M. Stallman | 2005-02-26 23:57:40 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-02-26 23:57:40 +0000 |
| commit | 1e04ba2c9054fb1645226a3448cc6c5325d72591 (patch) | |
| tree | dd1f9f8dd05bd46080df82bbc88efaed3d403953 | |
| parent | 79a6c76c3d9ed56a067435cc33ccba466abfb6c7 (diff) | |
| download | emacs-1e04ba2c9054fb1645226a3448cc6c5325d72591.tar.gz emacs-1e04ba2c9054fb1645226a3448cc6c5325d72591.zip | |
(Documentation Basics): Add function-documentation prop.
| -rw-r--r-- | lispref/help.texi | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/lispref/help.texi b/lispref/help.texi index ddc52253a80..dfbc6c220f3 100644 --- a/lispref/help.texi +++ b/lispref/help.texi | |||
| @@ -66,9 +66,13 @@ function or variable that it describes: | |||
| 66 | 66 | ||
| 67 | @itemize @bullet | 67 | @itemize @bullet |
| 68 | @item | 68 | @item |
| 69 | The documentation for a function is stored in the function definition | 69 | @kindex function-documentation |
| 70 | itself (@pxref{Lambda Expressions}). The function @code{documentation} | 70 | The documentation for a function is usually stored in the function |
| 71 | knows how to extract it. | 71 | definition itself (@pxref{Lambda Expressions}). The function |
| 72 | @code{documentation} knows how to extract it. You can also put | ||
| 73 | function documentation in the @code{function-documentation} property | ||
| 74 | of the function name. That is useful with definitions such as | ||
| 75 | keyboard macros that can't hold a documentation string. | ||
| 72 | 76 | ||
| 73 | @item | 77 | @item |
| 74 | @kindex variable-documentation | 78 | @kindex variable-documentation |