diff --git a/docs/scripting.xml b/docs/scripting.xml index 23f0a6a0f..278dc7f23 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -1674,7 +1674,7 @@ local localip, localport = client_service:get_info() Script Documentation Writing Nmap Scripting Engine (NSE)documentation in - NSEDocNmap Scripting Engine, documentation in + NSEDoc Scripts are used by more than just their author, so scripts must @@ -1688,8 +1688,9 @@ local localip, localport = client_service:get_info() NSE uses a customized version of the - LuaDoc - documentation system called NSEDoc. The documentation for scripts + LuaDocLuaDoc + documentation system called NSEDoc. + The documentation for scripts and modules is contained in their source code, in the form of comments with a special form. @@ -1951,11 +1952,12 @@ categories = {"discovery", "external"} NSE Documentation for C Modules + NSEDocfor C modules NSEDoc documentation can be written for libraries as well as scripts. But while Lua modules are documented in much the same way, a C module requires special consideration. You must write a - .luadoc.luadoc filename extension + .luadoc.luadoc filename extension file to accompany the C module in order for it to be documented. These files are typically placed in the nselib directory next to other Lua modules. The file itself will list all functions @@ -1967,6 +1969,8 @@ categories = {"discovery", "external"} know what it is you are documenting, especially for tables. + +