From 3dfc8bff15a74cbb6da3ebb3718fc30b5ebad195 Mon Sep 17 00:00:00 2001 From: Philipp Stephani Date: Tue, 22 Feb 2022 21:39:32 +0100 Subject: [PATCH] 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. --- doc/lispref/internals.texi | 6 +++--- 1 file 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 27.1. @anchor{process_input} -@deftypefn Function enum emacs_process_input_result process_input (emacs_env *@var{env}) +@deftypefn Function {enum emacs_process_input_result} process_input (emacs_env *@var{env}) This function processes pending input events. It returns @code{emacs_process_input_quit} if the user wants to quit or an error occurred while processing signals. In that case, we recommend that @@ -2127,7 +2127,7 @@ Therefore, we recommend that your module functions check for nonlocal exit conditions and recover from them, using the functions described below. -@deftypefn Function enum emacs_funcall_exit non_local_exit_check (emacs_env *@var{env}) +@deftypefn Function {enum emacs_funcall_exit} non_local_exit_check (emacs_env *@var{env}) This function returns the kind of nonlocal exit condition stored in @var{env}. The possible values are: @@ -2142,7 +2142,7 @@ The last @acronym{API} function exited via @code{throw}. @end vtable @end deftypefn -@deftypefn Function enum emacs_funcall_exit non_local_exit_get (emacs_env *@var{env}, emacs_value *@var{symbol}, emacs_value *@var{data}) +@deftypefn Function {enum emacs_funcall_exit} non_local_exit_get (emacs_env *@var{env}, emacs_value *@var{symbol}, emacs_value *@var{data}) This function returns the kind of nonlocal exit condition stored in @var{env}, like @code{non_local_exit_check} does, but it also returns the full information about the nonlocal exit, if any. If the return -- 2.39.2