From 5ab63a55be275c203297394bbc3c4dd6ba612861 Mon Sep 17 00:00:00 2001 From: david Date: Thu, 8 Apr 2010 05:26:42 +0000 Subject: [PATCH] Say that @usage applies to modules. Say that @usage is automatically generated for scripts if omitted. --- docs/scripting.xml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/scripting.xml b/docs/scripting.xml index 9f02faf9b..d87b1624c 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -2211,10 +2211,13 @@ categories = {"discovery", "external"} - 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. - @usage may be given more than once. + script it is an Nmap command line; and for a module it is usually + a code sample. + @usage may be given more than once. If it is + omitted in a script, NSEDoc generates a default standardized + usage example.