Next: ElDoc Mode, Previous: Writing Documentation Strings, Up: Documentation [Index]
documentation-property
Commanddocumentation-property
This function returns the documentation string recorded in ‘SYMBOL’ ’s property list under property ‘PROPERTY’. It is most often used to look up the documentation strings of variables.
This differs from get
in that it can refer to strings stored in the
‘etc/DOC’ file; and that it evaluates documentation properties that aren’t
strings.
For function documentation, use the documentation
function.
lambda
or defun
form), the documentation
string is specified after the argument list, and is normally stored
directly in the function object.
defvar
form), the documentation string is
specified after the initial value. The string is stored in the variable’s
variable-documentation property.
DOC
, in the directory
specified by doc-directory
.
"/Applications/MacPorts/Emacs.app/Contents/Resources/etc/DOC"