Nmap Development mailing list archives
Re: Showing local functions in NSEDoc
From: Patrik Karlsson <patrik () cqure net>
Date: Sun, 17 Oct 2010 06:14:11 +0200
On 16 okt 2010, at 21.48, Fyodor wrote:
On Fri, Oct 15, 2010 at 10:51:48PM -0700, David Fifield wrote:On Fri, Oct 15, 2010 at 12:17:30PM -0500, Ron wrote:On Fri, 15 Oct 2010 12:13:06 -0500 Kris Katterjohn <katterjohn () gmail com> wrote: 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.This is what I do when documenting local functions. I'm also in favor of removing local functions from the NSEDoc. NSEDoc already has the capability to do that built in--you just use the --nolocals option.OK, I've added --nolocals to the generation Makefile and regenerated the pages at http://nmap.org/nsedoc/. If there is a desire to have the local functions documented on the nsedoc pages at some point, maybe we'll put them in separate sections at the bottom so they don't obscure the public interface.
There are a few libraries that have used the convention below and probably have some "local" functions that "shouldn't" be in nsedoc. func = function(param1, param2) They would need to be addressed by removing the leading --- for functions that should not show up. I also noticed that the generated nsedoc does look very good for the libraries that use a class approach (e.g. drda, afp ...)
Cheers, -F _______________________________________________ Sent through the nmap-dev mailing list http://cgi.insecure.org/mailman/listinfo/nmap-dev Archived at http://seclists.org/nmap-dev/
//Patrik -- Patrik Karlsson http://www.cqure.net http://www.twitter.com/nevdull77 _______________________________________________ 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)