[Bro-Dev] #563: Check topic/broccoli-manual-rest
Bro Tracker
bro at tracker.bro-ids.org
Wed Sep 7 10:08:37 PDT 2011
#563: Check topic/broccoli-manual-rest
----------------------------+------------------------
Reporter: robin | Owner: jsiwek
Type: Merge Request | Status: assigned
Priority: Low | Milestone: Bro1.6
Component: Broccoli | Version: git/master
Resolution: | Keywords:
----------------------------+------------------------
Comment (by jsiwek):
> Yeah, but it would be good if we integrated the two (rst manual and
> current API docs) in some form at least. I don't know how the API docs
> are generated. Can we remove the old SGML docs but keep the current
> API doc generation for now?
The old API doc generation was never integrated with CMake and seems
harder to repair than to just start from scratch and use Doxygen instead,
so I've done that.
So now there's two components under that `doc/` directory: 1) the reST
manual and 2) the framework to generate HTML API docs via Doxygen
The best way of integrating those into the `www` is still an open question
(I'm trying to figure out a good scheme to collect/group documentation
according to Bro version), but I think you can consider merging this
branch as that gets sorted out separately.
--
Ticket URL: <http://tracker.bro-ids.org/bro/ticket/563#comment:11>
Bro Tracker <http://tracker.bro-ids.org/bro>
Bro Issue Tracker
More information about the bro-dev
mailing list