90 |
<dd><p>The <code>@deffn</code> command is the general definition command for |
<dd><p>The <code>@deffn</code> command is the general definition command for |
91 |
functions, interactive commands, and similar entities that may take |
functions, interactive commands, and similar entities that may take |
92 |
arguments. You must choose a term to describe the category of entity |
arguments. You must choose a term to describe the category of entity |
93 |
being defined; for example, "Function" could be used if the entity is |
being defined; for example, “Function” could be used if the entity is |
94 |
a function. The <code>@deffn</code> command is written at the beginning of a |
a function. The <code>@deffn</code> command is written at the beginning of a |
95 |
line and is followed on the same line by the category of entity being |
line and is followed on the same line by the category of entity being |
96 |
described, the name of this particular entity, and its arguments, if |
described, the name of this particular entity, and its arguments, if |
104 |
@end deffn |
@end deffn |
105 |
</pre></td></tr></table> |
</pre></td></tr></table> |
106 |
|
|
107 |
<p>This shows a rather terse definition for a "command" named |
<p>This shows a rather terse definition for a “command” named |
108 |
<code>forward-char</code> with one argument, <var>nchars</var>. |
<code>forward-char</code> with one argument, <var>nchars</var>. |
109 |
</p> |
</p> |
110 |
<p><code>@deffn</code> prints argument names such as <var>nchars</var> in italics or |
<p><code>@deffn</code> prints argument names such as <var>nchars</var> in italics or |
111 |
upper case, as if <code>@var</code> had been used, because we think of these |
upper case, as if <code>@var</code> had been used, because we think of these |
112 |
names as metasyntactic variables--they stand for the actual argument |
names as metasyntactic variables—they stand for the actual argument |
113 |
values. Within the text of the description, write an argument name |
values. Within the text of the description, write an argument name |
114 |
explicitly with <code>@var</code> to refer to the value of the argument. In |
explicitly with <code>@var</code> to refer to the value of the argument. In |
115 |
the example above, we used <samp>`@var{nchars}'</samp> in this way. |
the example above, we used <samp>`@var{nchars}'</samp> in this way. |