1
0
mirror of https://github.com/nmap/nmap.git synced 2026-01-25 15:49:02 +00:00

Say that @usage applies to modules. Say that @usage is automatically

generated for scripts if omitted.
This commit is contained in:
david
2010-04-08 05:26:42 +00:00
parent 838127d565
commit 5ab63a55be

View File

@@ -2211,10 +2211,13 @@ categories = {"discovery", "external"}
<term><option>@usage</option></term>
<listitem>
<para>
Provides a usage example of a function or script. In
Provides a usage example of a function, script, or module. In
the case of a function, the example is Lua code; for a
script it is an Nmap command line.
<literal>@usage</literal> may be given more than once.
script it is an Nmap command line; and for a module it is usually
a code sample.
<literal>@usage</literal> may be given more than once. If it is
omitted in a script, NSEDoc generates a default standardized
usage example.
</para>
</listitem>
</varlistentry>