From: Philipp Stephani <phst@google.com>
Date: Thu, 17 Feb 2022 13:02:28 +0000 (+0100)
Subject: Fix indexing of module functions that return complex types.
X-Git-Tag: emacs-28.0.92~43
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e303cb18077538b5ec32e73ce8def958d40c361f;p=emacs.git

Fix indexing of module functions that return complex 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 Values): Enclose multi-word
return types in braces.
---

diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi
index 33664d949a2..39e26aaf8fb 100644
--- a/doc/lispref/internals.texi
+++ b/doc/lispref/internals.texi
@@ -1629,7 +1629,7 @@ This function returns the value of a Lisp float specified by
 @var{arg}, as a C @code{double} value.
 @end deftypefn
 
-@deftypefn Function struct timespec extract_time (emacs_env *@var{env}, emacs_value @var{arg})
+@deftypefn Function {struct timespec} extract_time (emacs_env *@var{env}, emacs_value @var{arg})
 This function, which is available since Emacs 27, interprets @var{arg}
 as an Emacs Lisp time value and returns the corresponding @code{struct
 timespec}.  @xref{Time of Day}.  @code{struct timespec} represents a
@@ -1934,7 +1934,7 @@ garbage-collected.  Don't run any expensive code in a finalizer,
 because GC must finish quickly to keep Emacs responsive.
 @end deftypefn
 
-@deftypefn Function void *get_user_ptr (emacs_env *@var{env}, emacs_value @var{arg})
+@deftypefn Function {void *}get_user_ptr (emacs_env *@var{env}, emacs_value @var{arg})
 This function extracts the C pointer from the Lisp object represented
 by @var{arg}.
 @end deftypefn