[Bro-Dev] Writing documentation

Seth Hall seth at icir.org
Thu Dec 1 20:10:52 PST 2011


For the people that knew this was coming, I'm splitting out the documentation on the tracker into bundles.  I tried to keep it organized so that each bundle should be about as much work as the others.  So far I have the frameworks split up and I'll be splitting up the protocols and other various documentation needy bits soon.

Jon and I talked this afternoon and we decided that the right thing to do right now is just to write a very short blurb in the summary comment section (the ##! comments at the top) then make sure that everything in the export section is documented.  That includes each field in record definitions, exported function prototypes, and configuration variables.

In normal ## documentation comments, the first sentence is also special and is used as a summary somewhere.  Jon, could you provide an actual explanation of what the first sentence is used for?  I don't think I'm qualified to do it. :)

Anyway, you should be able to claim tickets in the tracker by assigning them to yourself.  If anyone that isn't listed as a developer on the tracker would like to get all masochistic and help out with documentation, get in touch with me and we'll work something out.

Direct links to the current documentation bundles:
	http://tracker.bro-ids.org/bro/ticket/706
	http://tracker.bro-ids.org/bro/ticket/707
	http://tracker.bro-ids.org/bro/ticket/708
	http://tracker.bro-ids.org/bro/ticket/709

  .Seth

--
Seth Hall
International Computer Science Institute
(Bro) because everyone has a network
http://www.bro-ids.org/




More information about the bro-dev mailing list