[Bro-Dev] #513: topic/jsiwek/update-restdoc-target

[Bro Tracker]

#513: topic/jsiwek/update-restdoc-target
----------------------------+------------------------
  Reporter:  jsiwek         |      Owner:  jsiwek
      Type:  Merge Request  |     Status:  assigned
  Priority:  Normal         |  Milestone:  Bro1.6
 Component:  Bro            |    Version:  git/master
Resolution:                 |   Keywords:
----------------------------+------------------------

Comment (by jsiwek):

 > - you added many @loads. Are they necessary only so that the doc
 generation works and not otherwise because normally the scripts would be
 pulled in implicitly? If indeed so, this is not so great: we will probably
 run into the problem all the time because it will only show up when docs
 are generated. However, I don't have a good idea right now how to address
 that.

 No, the addition of those @loads fixed errors that show up irrespective of
 enabling documentation mode.

 > - The change from ProtocolFound to Protocol_Found: is that according to
 our new naming conventions?

 That's the format that was used in most places, but the variable naming
 convention ticket, #484, doesn't seem to have a special rule for Notices
 (enums are actually supposed to be all caps).  Going to follow up in that
 ticket..

 > - One chunk adds a commit `#This should be optional`:  why isn't it?

 I didn't add or delete that comment, I just changed from "##"-style
 comment to a regular "#" comment because the former has no meaning there
 and just outputs a warning to that effect.

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