[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[no subject]
From: |
Gavin D. Smith |
Date: |
Fri, 14 Jul 2023 11:15:08 -0400 (EDT) |
branch: master
commit 58191c5cf6ab66b6f7f98bebd1abf3d5389614b5
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Fri Jul 14 16:14:23 2023 +0100
* doc/texinfo.texi (Generic Definition Commands), NEWS:
Document @deftypeline.
---
ChangeLog | 5 +++++
NEWS | 4 ++--
doc/texinfo.texi | 16 +++++++++++-----
3 files changed, 18 insertions(+), 7 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index e065c401f9..266e7aa093 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2023-07-14 Gavin Smith <gavinsmith0123@gmail.com>
+
+ * doc/texinfo.texi (Generic Definition Commands), NEWS:
+ Document @deftypeline.
+
2023-07-12 Gavin Smith <gavinsmith0123@gmail.com>
* NEWS: remove reverted change about index commands ending
diff --git a/NEWS b/NEWS
index c81ebd27a3..7d896bd31e 100644
--- a/NEWS
+++ b/NEWS
@@ -10,8 +10,8 @@ See the manual for detailed information.
------------------------------------------------------------------------------
* Language
- . new generic definition commands, @defblock and @defline, that do not
- automatically create index entries
+ . new generic definition commands, @defblock, @defline and @deftypeline,
+ that do not automatically create index entries
. new command @link to create plain links in output formats which support
this
. @cartouche takes an argument to specify the cartouche title
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 339d757433..e3c9a14aa0 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -12172,26 +12172,28 @@ index entries.
@findex defblock
@findex defline
+@findex deftypeline
You create a generic definition environment with @samp{@@defblock}
paired with @samp{@@end defblock}. Within this environment, use a
-@code{@@defline} line for each symbol you document. For example:
+@code{@@defline} or @code{@@deftypeline} line for each symbol you
+document. For example:
@example
@@defblock
-@@defline Builtin foo (bar)
-Description of foo.
@@defline Macro mac (arg1, arg2)
Description of mac.
+@@deftypeline Builtin int foo (int @@var@{bar@})
+Description of foo.
@@end defblock
@end example
@noindent This produces the output:
@defblock
-@defline Builtin foo (bar)
-Description of foo.
@defline Macro mac (arg1, arg2)
Description of mac.
+@deftypeline Builtin int foo (int @var{bar})
+Description of foo.
@end defblock
The syntax of @code{@@defline} is similar to that of @code{@@deffn}.
@@ -12199,6 +12201,10 @@ The first argument gives a category for the
definition. Follow this
with the symbol name, followed by any parameters. You should surround
any arguments containing spaces with braces.
+You use @code{@@deftypeline} in a similar way to @code{@@deftypefn},
+following the category with a data type, and marking any parameters
+with @code{@@var}. (@xref{Typed Functions}).)
+
To share the same description for multiple symbols, you can put several
@code{@@defline} lines together. For example: