[Bro-Dev] first try at a skeleton script

Adam Slagell slagell at ncsa.illinois.edu
Mon Oct 4 18:28:18 PDT 2010


Probably a good idea. If they are messing with internal interface, probably easier to look at source code than bring up a separate documentation manual. It would be easy to flood the documentation with so much information that it serves no purpose beyond just reading comments in source directly

On Oct 4, 2010, at 4:20 PM, Gregor Maier <gregor at icir.org> wrote:

> 
> Or maybe the per-element doc-comments can have a flag indicating whether
> they are public interface or internal functionality. Then the doc
> generator can separate these elements for the output. Then a user can
> quickly see, what's relevant (which events, functions, globals) and
> somebody who needs to understand the script (to enhance, modify,
> whatever) also has all the information.




More information about the bro-dev mailing list