[Bro-Dev] Thoughts on documenting scripts

Robin Sommer robin at icir.org
Fri Dec 3 15:27:45 PST 2010


On Fri, Dec 03, 2010 at 15:06 -0500, you wrote:

> One question I just came across was how to document the values for
> an enum.  My example is below, I think it would be nice to either
> link to the potential values for that enum or include them inline (I
> think I prefer inline).

I'm not quite sure which alternatives you describe here, but my
thiking would be to document (1) the enum tyoe itself, and then (2)
the various values indvidually, e.g.:

# Defines the alternatives for XYZ.
type Directions: enum {

    ## Description for inbound.
    Inbound,

    ## Description for outbound.
    Outbound

    ...
};

Is that what you mean by "inline"?

Robin

-- 
Robin Sommer * Phone +1 (510) 722-6541 * robin at icir.org
ICSI/LBNL    * Fax   +1 (510) 666-2956 *   www.icir.org



More information about the bro-dev mailing list