Nmap Development mailing list archives
Re: Showing local functions in NSEDoc
From: Ron <ron () skullsecurity net>
Date: Fri, 15 Oct 2010 12:17:30 -0500
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On Fri, 15 Oct 2010 12:13:06 -0500 Kris Katterjohn <katterjohn () gmail com> wrote:
I agree here, but if simply not using "---" prevents the NSEDoc from being generated (which was my understanding and also Patrick mentions this above) then I think that's a good enough solution (since this is NSEDoc syntax). I don't think NSEDoc system should behave this way: "the author writes in NSEDoc format, but I should ignore what appears to be the author's wishes if the function is defined as local" because viewed this way it seems like the author is conflicted. Of course, if NSEDoc blatantly ignored the author or if it was always generating docs for local functions without the NSEDoc "---" syntax then I would be all for changing NSEDoc (but this isn't the case AFAIK).
True, that's another solution. But it comes back to Patrick's comment, what if these functions are exposed another way in the future? Having proper NSEDoc for local functions might be appropriate in some cases, especially if we want complete documentation (not just for the interface), but it isn't something that should be on the main site, in my opinion. I'm willing to go either way, though. I'm okay with removing the '---' on any function that doesn't need to be documented on nmap.org. Ron -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAky4jK0ACgkQ2t2zxlt4g/R12QCeI6i1DxdTi87VTh0fYgmIwVGE j9QAoL3lunBHWeyuJlxnWbhCVfhZ5yiU =XKGK -----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/
Current thread:
- Showing local functions in NSEDoc Ron (Oct 14)
- Re: Showing local functions in NSEDoc Patrick Donnelly (Oct 14)
- Re: Showing local functions in NSEDoc Ron (Oct 15)
- Re: Showing local functions in NSEDoc Kris Katterjohn (Oct 15)
- Re: Showing local functions in NSEDoc Ron (Oct 15)
- Re: Showing local functions in NSEDoc David Fifield (Oct 15)
- Re: Showing local functions in NSEDoc Fyodor (Oct 16)
- Re: Showing local functions in NSEDoc Patrik Karlsson (Oct 16)
- Re: Showing local functions in NSEDoc Ron (Oct 15)
- Re: Showing local functions in NSEDoc Patrick Donnelly (Oct 14)