From aac3a4e0ad786fee3f7012c4dff0a54d8f1e74a9 Mon Sep 17 00:00:00 2001 From: david Date: Mon, 27 Oct 2008 15:31:38 +0000 Subject: [PATCH] Polish some markup in scripting.xml. Index ".luadoc". --- docs/scripting.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/scripting.xml b/docs/scripting.xml index d0927ed81..23f0a6a0f 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -1954,15 +1954,16 @@ categories = {"discovery", "external"} 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" file to accompany the C module in order for it to be + requires special consideration. You must write a + .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 for the C module as though they were written in Lua. You may however remove certain syntactical structures (particularly, end) when writing this document, as it is never compiled by Lua. Remember you may use the - @class tag to also help the parser + @class tag to also help the parser know what it is you are documenting, especially for tables.