]> git.eshelyaron.com Git - emacs.git/commitdiff
Fix indexing of module functions that return enumeration types.
authorPhilipp Stephani <phst@google.com>
Tue, 22 Feb 2022 20:39:32 +0000 (21:39 +0100)
committerPhilipp Stephani <phst@google.com>
Tue, 22 Feb 2022 20:39:32 +0000 (21:39 +0100)
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

index 39e26aaf8fbc3f332621c9bf8186c7f01b898835..14d6c34e17d624ca8e1c544b413825f49b0fbbc5 100644 (file)
@@ -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