aboutsummaryrefslogtreecommitdiffstats
path: root/src/coding.c
diff options
context:
space:
mode:
authorEli Zaretskii2025-03-09 15:02:39 +0200
committerEli Zaretskii2025-03-09 15:02:39 +0200
commit59d1aac49dfdc49e34be5964f547db0cfa7e127b (patch)
treed77d8fa81094e38c5117bbe339ee6f13affae12a /src/coding.c
parent35c7837c6616b3a2b845ba06d3ed797bb12fb749 (diff)
downloademacs-59d1aac49dfdc49e34be5964f547db0cfa7e127b.tar.gz
emacs-59d1aac49dfdc49e34be5964f547db0cfa7e127b.zip
Document return values of the various read-* functions
* lisp/textmodes/string-edit.el (read-string-from-buffer): * lisp/simple.el (read-from-kill-ring, read-shell-command) (read-signal-name): * lisp/replace.el (read-regexp-case-fold-search): * lisp/auth-source.el (read-passwd): * lisp/subr.el (read-key, read-number): * lisp/minibuffer.el (read-file-name, read-no-blanks-input): * lisp/international/mule-cmds.el (read-multilingual-string): * lisp/language/japan-util.el (read-hiragana-string): * lisp/files-x.el (read-file-local-variable) (read-file-local-variable-mode, read-file-local-variable-value): * lisp/faces.el (read-face-font, read-face-name): * lisp/simple.el (read-extended-command): * lisp/env.el (read-envvar-name): * lisp/files.el (read-directory-name): * lisp/faces.el (read-color): * lisp/international/mule-diag.el (read-charset): * lisp/emacs-lisp/map-ynp.el (read-answer): * src/coding.c (Fread_coding_system) (Fread_non_nil_coding_system): * src/minibuf.c (Fread_command, Fread_from_minibuffer): * src/lread.c (Fread_char, Fread_char_exclusive, Fread_event): Doc fixes.
Diffstat (limited to 'src/coding.c')
-rw-r--r--src/coding.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/coding.c b/src/coding.c
index b8ed3a35957..619a362d328 100644
--- a/src/coding.c
+++ b/src/coding.c
@@ -8625,7 +8625,8 @@ about coding-system objects. */)
8625 8625
8626DEFUN ("read-non-nil-coding-system", Fread_non_nil_coding_system, 8626DEFUN ("read-non-nil-coding-system", Fread_non_nil_coding_system,
8627 Sread_non_nil_coding_system, 1, 1, 0, 8627 Sread_non_nil_coding_system, 1, 1, 0,
8628 doc: /* Read a coding system from the minibuffer, prompting with string PROMPT. */) 8628 doc: /* Read a coding system from the minibuffer, prompting with string PROMPT.
8629Return the symbol of the coding-system. */)
8629 (Lisp_Object prompt) 8630 (Lisp_Object prompt)
8630{ 8631{
8631 Lisp_Object val; 8632 Lisp_Object val;
@@ -8641,6 +8642,8 @@ DEFUN ("read-non-nil-coding-system", Fread_non_nil_coding_system,
8641DEFUN ("read-coding-system", Fread_coding_system, Sread_coding_system, 1, 2, 0, 8642DEFUN ("read-coding-system", Fread_coding_system, Sread_coding_system, 1, 2, 0,
8642 doc: /* Read a coding system from the minibuffer, prompting with string PROMPT. 8643 doc: /* Read a coding system from the minibuffer, prompting with string PROMPT.
8643If the user enters null input, return second argument DEFAULT-CODING-SYSTEM. 8644If the user enters null input, return second argument DEFAULT-CODING-SYSTEM.
8645Return the coding-system's symbol, or nil if both the user input and
8646DEFAULT-CODING-SYSTEM are empty or null.
8644Ignores case when completing coding systems (all Emacs coding systems 8647Ignores case when completing coding systems (all Emacs coding systems
8645are lower-case). */) 8648are lower-case). */)
8646 (Lisp_Object prompt, Lisp_Object default_coding_system) 8649 (Lisp_Object prompt, Lisp_Object default_coding_system)