Re: Showing local functions in NSEDoc

[Ron <ron () skullsecurity net>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Thu, 14 Oct 2010 23:12:59 -0400 Patrick Donnelly <batrick () batbytes com> wrote:
> The local functions might be later exposed in another way so I don't
> think we should stop NSEDoc from handling local functions. Instead,
> author's should not turn on NSEDoc (---) when documenting private
> functions. (They can still use the NSEDoc syntax for consistency I
> guess.)

My thought is this. I want to write a script that uses the DNS library. So I open up the NSEDoc for DNS and get this:
http://nmap.org/nsedoc/lib/dns.html 

There are over 30 functions defined there, most of which are completely irrelevant to somebody who just wants to use 
the DNS library. Same deal with dhcp:
http://nmap.org/nsedoc/lib/dhcp.html

There are over 12 functions defined there, but only one that people actually can (and should) use. 

If NSEDoc is supposed to help people write scripts, including local functions in it is, in my opinion, making things 
more difficult. 

Ron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAky4apkACgkQ2t2zxlt4g/QtHgCfaayDgCyb4V1k/GgeJkZgGHUd
ZLkAnj+Z5IN2cP7vxNvoQBVVlKRcbOmR
=goIx
-----END PGP SIGNATURE-----
_______________________________________________
Sent through the nmap-dev mailing list
http://cgi.insecure.org/mailman/listinfo/nmap-dev
Archived at http://seclists.org/nmap-dev/