[Bro-Dev] #563: Check topic/broccoli-manual-rest

[Bro Tracker]

#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 robin):

 Tried to merge this, but some issues:

 - I get this error with `make doc`:

 {{{
 Generating file member index...
 finalizing index lists...
 finished...
 [100%] Built target broccolidoc
 make[4]: *** No rule to make target `broccolidoc', needed by
 `doc/CMakeFiles/doc'.  Stop.
 make[3]: *** [doc/CMakeFiles/doc.dir/all] Error 2
 make[2]: *** [doc/CMakeFiles/doc.dir/rule] Error 2
 make[1]: *** [doc] Error 2
 make: *** [doc] Error 2

 }}}

 -  The generated Doxygen docs show the data structures on the overview
 page but not the more important functions. Also, they don't seem to pick
 up some (all?) of the comments. This is Doxygen 1.7.2 if it matters.

 - Generally I think we don't need/want to document all the internal stuff.
 An equivalent of this page would be good:
 http://www.icir.org/christian/broccoli/manual/broccoli-broccoli.html I
 believe that's just `broccoli.h`.

-- 
Ticket URL: <http://tracker.bro-ids.org/bro/ticket/563#comment:14>
Bro Tracker <http://tracker.bro-ids.org/bro>
Bro Issue Tracker