diff options
| author | Philipp Stephani | 2022-02-22 21:39:32 +0100 |
|---|---|---|
| committer | Philipp Stephani | 2022-02-22 21:39:32 +0100 |
| commit | 3dfc8bff15a74cbb6da3ebb3718fc30b5ebad195 (patch) | |
| tree | 82fbd1909c3a5dd4489c8039f0fb1014d2a3fc7f | |
| parent | 86c0d9eb5fc309413696694c53e1eee9070caea6 (diff) | |
| download | emacs-3dfc8bff15a74cbb6da3ebb3718fc30b5ebad195.tar.gz emacs-3dfc8bff15a74cbb6da3ebb3718fc30b5ebad195.zip | |
Fix indexing of module functions that return enumeration types.
Return types that consist of more than one word need to be enclosed in
braces, see Info node `(texinfo) Typed Functions'. Otherwise they are
indexed incorrectly.
* doc/lispref/internals.texi (Module Misc, Module Nonlocal): Enclose
multi-word return types in braces.
| -rw-r--r-- | doc/lispref/internals.texi | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi index 39e26aaf8fb..14d6c34e17d 100644 --- a/doc/lispref/internals.texi +++ b/doc/lispref/internals.texi | |||
| @@ -2052,7 +2052,7 @@ to quit, use the following function, which is available since Emacs | |||
| 2052 | 27.1. | 2052 | 27.1. |
| 2053 | 2053 | ||
| 2054 | @anchor{process_input} | 2054 | @anchor{process_input} |
| 2055 | @deftypefn Function enum emacs_process_input_result process_input (emacs_env *@var{env}) | 2055 | @deftypefn Function {enum emacs_process_input_result} process_input (emacs_env *@var{env}) |
| 2056 | This function processes pending input events. It returns | 2056 | This function processes pending input events. It returns |
| 2057 | @code{emacs_process_input_quit} if the user wants to quit or an error | 2057 | @code{emacs_process_input_quit} if the user wants to quit or an error |
| 2058 | occurred while processing signals. In that case, we recommend that | 2058 | occurred while processing signals. In that case, we recommend that |
| @@ -2127,7 +2127,7 @@ Therefore, we recommend that your module functions check for nonlocal | |||
| 2127 | exit conditions and recover from them, using the functions described | 2127 | exit conditions and recover from them, using the functions described |
| 2128 | below. | 2128 | below. |
| 2129 | 2129 | ||
| 2130 | @deftypefn Function enum emacs_funcall_exit non_local_exit_check (emacs_env *@var{env}) | 2130 | @deftypefn Function {enum emacs_funcall_exit} non_local_exit_check (emacs_env *@var{env}) |
| 2131 | This function returns the kind of nonlocal exit condition stored in | 2131 | This function returns the kind of nonlocal exit condition stored in |
| 2132 | @var{env}. The possible values are: | 2132 | @var{env}. The possible values are: |
| 2133 | 2133 | ||
| @@ -2142,7 +2142,7 @@ The last @acronym{API} function exited via @code{throw}. | |||
| 2142 | @end vtable | 2142 | @end vtable |
| 2143 | @end deftypefn | 2143 | @end deftypefn |
| 2144 | 2144 | ||
| 2145 | @deftypefn Function enum emacs_funcall_exit non_local_exit_get (emacs_env *@var{env}, emacs_value *@var{symbol}, emacs_value *@var{data}) | 2145 | @deftypefn Function {enum emacs_funcall_exit} non_local_exit_get (emacs_env *@var{env}, emacs_value *@var{symbol}, emacs_value *@var{data}) |
| 2146 | This function returns the kind of nonlocal exit condition stored in | 2146 | This function returns the kind of nonlocal exit condition stored in |
| 2147 | @var{env}, like @code{non_local_exit_check} does, but it also returns | 2147 | @var{env}, like @code{non_local_exit_check} does, but it also returns |
| 2148 | the full information about the nonlocal exit, if any. If the return | 2148 | the full information about the nonlocal exit, if any. If the return |