From 147a17d2b6d8f0e1649edfb91f2493073b4e3cdf Mon Sep 17 00:00:00 2001 From: david Date: Thu, 16 Aug 2012 12:14:54 +0000 Subject: [PATCH] Add @xmloutput to docs/scripting.xml. --- docs/scripting.xml | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/scripting.xml b/docs/scripting.xml index 88c2132a6..e518c67c1 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -2771,8 +2771,8 @@ local localip, localport = try(client_service:get_info()) @copyright belong in the variables author and license instead. NSEDoc knows about these variables and will use them in preference - to fields in the comments. Scripts should also have an - @output tag showing sample output, as well as @args and @usage where appropriate. + to fields in the comments. Scripts should also have + @output and @xmloutput tags showing sample output, as well as @args and @usage where appropriate. shows proper form for script-level documentation, using a combination of documentation comments and NSE variables. @@ -2939,6 +2939,19 @@ categories = {"discovery", "external", "safe"} + + + + + Shows what the script's + structured output + looks like when written to XML. The XML sample should not include + the enclosing <script> and + </script> tags and should be indented to + show hierarchy. + + +