304 |
} |
} |
305 |
|
|
306 |
DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0, |
DEFUN ("documentation", Fdocumentation, Sdocumentation, 1, 2, 0, |
307 |
"Return the documentation string of FUNCTION.\n\ |
doc: /* Return the documentation string of FUNCTION. |
308 |
Unless a non-nil second argument RAW is given, the\n\ |
Unless a non-nil second argument RAW is given, the |
309 |
string is passed through `substitute-command-keys'.") |
string is passed through `substitute-command-keys'. */) |
310 |
(function, raw) |
(function, raw) |
311 |
Lisp_Object function, raw; |
Lisp_Object function, raw; |
312 |
{ |
{ |
313 |
Lisp_Object fun; |
Lisp_Object fun; |
391 |
|
|
392 |
DEFUN ("documentation-property", Fdocumentation_property, |
DEFUN ("documentation-property", Fdocumentation_property, |
393 |
Sdocumentation_property, 2, 3, 0, |
Sdocumentation_property, 2, 3, 0, |
394 |
"Return the documentation string that is SYMBOL's PROP property.\n\ |
doc: /* Return the documentation string that is SYMBOL's PROP property. |
395 |
Third argument RAW omitted or nil means pass the result through\n\ |
Third argument RAW omitted or nil means pass the result through |
396 |
`substitute-command-keys' if it is a string.\n\ |
`substitute-command-keys' if it is a string. |
397 |
\n\ |
|
398 |
This differs from `get' in that it can refer to strings stored in the\n\ |
This differs from `get' in that it can refer to strings stored in the |
399 |
`etc/DOC' file; and that it evaluates documentation properties that\n\ |
`etc/DOC' file; and that it evaluates documentation properties that |
400 |
aren't strings.") |
aren't strings. */) |
401 |
(symbol, prop, raw) |
(symbol, prop, raw) |
402 |
Lisp_Object symbol, prop, raw; |
Lisp_Object symbol, prop, raw; |
403 |
{ |
{ |
461 |
|
|
462 |
|
|
463 |
DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation, |
DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation, |
464 |
1, 1, 0, |
1, 1, 0, |
465 |
"Used during Emacs initialization, before dumping runnable Emacs,\n\ |
doc: /* Used during Emacs initialization, before dumping runnable Emacs, |
466 |
to find pointers to doc strings stored in `etc/DOC...' and\n\ |
to find pointers to doc strings stored in `etc/DOC...' and |
467 |
record them in function definitions.\n\ |
record them in function definitions. |
468 |
One arg, FILENAME, a string which does not include a directory.\n\ |
One arg, FILENAME, a string which does not include a directory. |
469 |
The file is found in `../etc' now; found in the `data-directory'\n\ |
The file is found in `../etc' now; found in the `data-directory' |
470 |
when doc strings are referred to later in the dumped Emacs.") |
when doc strings are referred to later in the dumped Emacs. */) |
471 |
(filename) |
(filename) |
472 |
Lisp_Object filename; |
Lisp_Object filename; |
473 |
{ |
{ |
474 |
int fd; |
int fd; |
568 |
} |
} |
569 |
|
|
570 |
DEFUN ("substitute-command-keys", Fsubstitute_command_keys, |
DEFUN ("substitute-command-keys", Fsubstitute_command_keys, |
571 |
Ssubstitute_command_keys, 1, 1, 0, |
Ssubstitute_command_keys, 1, 1, 0, |
572 |
"Substitute key descriptions for command names in STRING.\n\ |
doc: /* Substitute key descriptions for command names in STRING. |
573 |
Return a new string which is STRING with substrings of the form \\=\\[COMMAND]\n\ |
Return a new string which is STRING with substrings of the form \\=\\[COMMAND] |
574 |
replaced by either: a keystroke sequence that will invoke COMMAND,\n\ |
replaced by either: a keystroke sequence that will invoke COMMAND, |
575 |
or \"M-x COMMAND\" if COMMAND is not on any keys.\n\ |
or "M-x COMMAND" if COMMAND is not on any keys. |
576 |
Substrings of the form \\=\\{MAPVAR} are replaced by summaries\n\ |
Substrings of the form \\=\\{MAPVAR} are replaced by summaries |
577 |
\(made by describe-bindings) of the value of MAPVAR, taken as a keymap.\n\ |
\(made by describe-bindings) of the value of MAPVAR, taken as a keymap. |
578 |
Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR\n\ |
Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR |
579 |
as the keymap for future \\=\\[COMMAND] substrings.\n\ |
as the keymap for future \\=\\[COMMAND] substrings. |
580 |
\\=\\= quotes the following character and is discarded;\n\ |
\\=\\= quotes the following character and is discarded; |
581 |
thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.") |
thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. */) |
582 |
(string) |
(string) |
583 |
Lisp_Object string; |
Lisp_Object string; |
584 |
{ |
{ |
585 |
unsigned char *buf; |
unsigned char *buf; |
815 |
staticpro (&Qfunction_documentation); |
staticpro (&Qfunction_documentation); |
816 |
|
|
817 |
DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name, |
DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name, |
818 |
"Name of file containing documentation strings of built-in symbols."); |
doc: /* Name of file containing documentation strings of built-in symbols. */); |
819 |
Vdoc_file_name = Qnil; |
Vdoc_file_name = Qnil; |
820 |
|
|
821 |
defsubr (&Sdocumentation); |
defsubr (&Sdocumentation); |