From: Andrea Corallo <acorallo@gnu.org>
Date: Mon, 29 Apr 2024 16:08:57 +0000 (+0200)
Subject: * Document function type declarations
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b63537b884408ff5b90c20a764ffb0535f09d3ab;p=emacs.git

* Document function type declarations

* doc/lispref/functions.texi (Declare Form): Document function type
declaration.

(cherry picked from commit 15016288ecaefbfb2822c1fcef7146a5d8663650)
---

diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index c57de08460f..b5e234fa068 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -2709,6 +2709,13 @@ native code emitted for the function.  In particular, if @var{n} is
 @minus{}1, native compilation of the function will emit bytecode
 instead of native code for the function.
 
+@item (type @var{type})
+Declare @var{type} to be the type of this function.  This is used for
+documentation by @code{describe-function}.  Also it can be used by the
+native compiler (@pxref{Native-Compilation}) for improving code
+generation and for deriving more precisely the type of other functions
+without type declaration.
+
 @item no-font-lock-keyword
 This is valid for macros only.  Macros with this declaration are
 highlighted by font-lock (@pxref{Font Lock Mode}) as normal functions,