mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.231 and 1.232

version 1.231, 2014/07/02 03:48:07

version 1.232, 2014/07/13 10:24:40

Line 1563 Function argument.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Fa

.Op Cm argtype

.Qo

.Cm argname

.Op Ar argtype

.Op Ar argname

.Qc Ar \&...

.Ed

.Pp

This may be invoked for names with or without the corresponding type.

Each argument may be a name and a type (recommended for the

It is also used to specify the field name of a structure.

.Em SYNOPSIS

section), a name alone (for function invocations),

or a type alone (for function prototypes).

If both a type and a name are given or if the type consists of multiple

words, all words belonging to the same function argument have to be

given in a single argument to the

.Sx \&Fa

macro.

.Pp

This macro is also used to specify the field name of a structure.

.Pp

Most often, the

.Sx \&Fa

macro is used in the

.Em SYNOPSIS

within

.Sx \&Fo

section when documenting multi-line function prototypes.

blocks when documenting multi-line function prototypes.

If invoked with multiple arguments, the arguments are separated by a

comma.

Furthermore, if the following macro is another

Line 1585 the last argument will also have a trailing comma.

Line 1597 the last argument will also have a trailing comma.

Examples:

.Dl \&.Fa \(dqconst char *p\(dq

.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq

.Dl \&.Fa foo

.Dl \&.Fa \(dqchar *\(dq size_t

.Pp