13.7 Generic Definition Commands

Texinfo provides commands for definitions that do not produce automatic index entries.

You create a generic definition environment with ‘@defblock’ paired with ‘@end defblock’. Within this environment, use a @defline or @deftypeline line for each symbol you document. For example:

@defblock
@defline Macro mac (arg1, arg2)
Description of mac.
@deftypeline Builtin int foo (int @var{bar})
Description of foo.
@end defblock

This produces the output:

Macro: mac (arg1, arg2)

Description of mac.

Builtin: int foo (int bar)

Description of foo.

The syntax of @defline is similar to that of @deffn. 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 @deftypeline in a similar way to @deftypefn, following the category with a data type, and marking any parameters with @var. (See Functions in Typed Languages).)

To share the same description for multiple symbols, you can put several @defline lines together. For example:

@defblock
@defline Function set-var (value)
@defline {Settable Variable} var
Description of set-var and var.
@end defblock

This produces the output:

Function: set-var (value)
Settable Variable: var

Description of set-var and var.

It may be useful to define line macros (see Line Macros) in combination with these commands.