Proofread and update documentation of pop3, shortport, snmp, ssh1, ssh2,

strbuf, tab, unpwdb, and url.

nselib/tab.lua

@@ -1,25 +1,28 @@
 --- Arrange output into tables.
--- \n\n
+--
 -- This module provides NSE scripts with a way to output structured tables
--- similar to NmapOutputTable.cc.
--- \n\n
--- Example usage:\n
--- local t = tab.new(2)\n
--- tab.add(t, 1, 'A1')\n
--- tab.add(t, 2, 'A2')\n
--- tab.nextrow(t)\n
--- tab.add(t, 1, 'BBBBBBBBB1')\n
--- tab.add(t, 2, 'BBB2')\n
+-- similar to what <code>NmapOutputTable.cc</code> provides.
+--
+-- Example usage:
+-- <code>
+-- local t = tab.new(2)
+-- tab.add(t, 1, 'A1')
+-- tab.add(t, 2, 'A2')
+-- tab.nextrow(t)
+-- tab.add(t, 1, 'BBBBBBBBB1')
+-- tab.add(t, 2, 'BBB2')
 -- tab.dump(t)
+-- </code>
 -- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
 
 module(... or "tab",package.seeall)
 
 require('strbuf')
 
---- Create and return a new table with a number of columns equal to cols and
+--- Create and return a new table with a given number of columns and
 -- the row counter set to 1.
--- @param cols the number of columns the table will hold.
+-- @param cols The number of columns the table will hold.
+-- @return A new table.
 function new(cols)
 	assert(cols > 0)
 	local table ={}
@@ -31,13 +34,12 @@ function new(cols)
 end
 
 --- Add a new string item to a table at a given column position.
--- \n\n
--- The item will be added to the current row. If nextrow hasn't been called yet
--- that will be row 1.
 --
--- @param t the table.
--- @param v the string to add.
--- @param c the column position at which to add the item.
+-- The item will be added to the current row. If <code>nextrow</code> hasn't
+-- been called yet that will be row 1.
+-- @param t The table.
+-- @param v The string to add.
+-- @param c The column position at which to add the item.
 function add(t, c, v)
 	assert(t)
 	assert(v)
@@ -59,11 +61,11 @@ function add(t, c, v)
 end
 
 --- Add a complete row to the table and move on to the next row.
--- \n\n
--- Calls add for each argument starting with the second argument
--- and after that calls nextrow.
--- @param t the table.
--- @param ... the elements to add to the row.
+--
+-- Calls <code>add</code> for each argument starting with the second argument
+-- and after that calls <code>nextrow</code>.
+-- @param t The table.
+-- @param ... The elements to add to the row.
 function addrow(t, ...)
 	for i=1, arg['n'] do
 		add( t, i, tostring(arg[i]) )
@@ -74,7 +76,7 @@ end
 --- Move on to the next row in the table. If this is not called
 -- then previous column values will be over-written by subsequent
 -- values.
--- @param t the table.
+-- @param t The table.
 function nextrow(t)
 	assert(t)
 	assert(t['rows'])
@@ -82,10 +84,10 @@ function nextrow(t)
 end
 
 --- Return a formatted string representation of the table.
--- \n\n
+--
 -- The number of spaces in a column is based on the largest element in the
 -- column with an additional two spaces for padding.
--- @param t the table.
+-- @param t The table.
 function dump(t)
 	assert(t)
 	assert(t['rows'])