1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-07 15:21:46 +00:00

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.
This commit is contained in:
Philipp Stephani 2022-02-17 14:02:28 +01:00
parent b30ef09919
commit e303cb1807

View File

@ -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