]> code.delx.au - gnu-emacs/commitdiff
(Documentation Basics): Add function-documentation prop.
authorRichard M. Stallman <rms@gnu.org>
Sat, 26 Feb 2005 23:57:40 +0000 (23:57 +0000)
committerRichard M. Stallman <rms@gnu.org>
Sat, 26 Feb 2005 23:57:40 +0000 (23:57 +0000)
lispref/help.texi

index ddc52253a8000a675e2cd63fc7222e22cf065968..dfbc6c220f3191d2a68991159c9505af36e8fc20 100644 (file)
@@ -66,9 +66,13 @@ function or variable that it describes:
 
 @itemize @bullet
 @item
-The documentation for a function is stored in the function definition
-itself (@pxref{Lambda Expressions}).  The function @code{documentation}
-knows how to extract it.
+@kindex function-documentation
+The documentation for a function is usually stored in the function
+definition itself (@pxref{Lambda Expressions}).  The function
+@code{documentation} knows how to extract it.  You can also put
+function documentation in the @code{function-documentation} property
+of the function name.  That is useful with definitions such as
+keyboard macros that can't hold a documentation string.
 
 @item
 @kindex variable-documentation