PenTest/nmap
1
0
Fork 0
mirror of https://github.com/nmap/nmap.git synced 2025-12-10 08:51:36 +00:00
Code Issues Projects Releases Wiki Activity

Improve idnexing in "Script Documentation Writing."

Browse Source
This commit is contained in:
david
2008-10-27 15:45:41 +00:00
parent aac3a4e0ad
commit 6ecda0239c
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/scripting.xml
View File

@@ -1674,7 +1674,7 @@ local localip, localport = client_service:get_info()
<sect1 id="nse-documentation">
<title>Script Documentation Writing</title>
<indexterm class="startofrange" id="nse-documentation-indexterm"><primary>Nmap Scripting Engine (NSE)</primary><secondary>documentation in</secondary></indexterm>
<indexterm><primary>NSEDoc</primary><see>Nmap Scripting Engine, documentation in</see></indexterm>
<indexterm class="startofrange" id="nse-nsedoc-indexterm"><primary>NSEDoc</primary></indexterm>
<para>
Scripts are used by more than just their author, so scripts must
@@ -1688,8 +1688,9 @@ local localip, localport = client_service:get_info()
<para>
NSE uses a customized version of the
<ulink url="http://luadoc.luaforge.net/">LuaDoc</ulink>
documentation system called NSEDoc. The documentation for scripts
<ulink url="http://luadoc.luaforge.net/">LuaDoc</ulink><indexterm><primary>LuaDoc</primary></indexterm>
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.
<xref linkend="nse-documentation-comment" xrefstyle="select: label nopage"/>
@@ -1951,11 +1952,12 @@ categories = {"discovery", "external"}
</sect2>
<sect2 id="nse-documentation-c">
<title>NSE Documentation for C Modules</title>
<indexterm><primary>NSEDoc</primary><secondary>for C modules</secondary></indexterm>
<para>
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
<filename>.luadoc</filename><indexterm><primary sortas="luadoc filename extension"></primary><filename>.luadoc</filename> filename extension</indexterm>
<filename>.luadoc</filename><indexterm><primary sortas="luadoc filename extension"><filename>.luadoc</filename> filename extension</primary></indexterm>
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.
</para>
</sect2>
<indexterm class="endofrange" startref="nse-documentation-indexterm"/>
<indexterm class="endofrange" startref="nse-nsedoc-indexterm"/>
</sect1>
<sect1 id="nse-vscan">