[Bro-Dev] [JIRA] (BIT-1483) broxygen ignores doc comments
Daniel Thayer (JIRA)
jira at bro-tracker.atlassian.net
Mon Sep 21 12:01:00 PDT 2015
[ https://bro-tracker.atlassian.net/browse/BIT-1483?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Daniel Thayer updated BIT-1483:
-------------------------------
Description:
Tried adding a documentation comment to an enum type, but broxygen ignores it.
It seems the problem is the name "Event" (if I rename the type name, then
the documentation comment is no longer ignored).
Example from frameworks/input/main.bro:
export {
## This line is ignored.
type Event: enum {
EVENT_NEW = 0,
EVENT_CHANGED = 1,
EVENT_REMOVED = 2,
};
was:
Tried adding a documentation comment to an enum type, but broxygen ignores it.
It seems the problem is the name "Event" (if I rename the type name, then
the documentation comment is no longer ignored).
Example from frameworks/input/main.bro:
export {
## This line is ignored.
type Event: enum {
## New data has been imported.
EVENT_NEW = 0,
## Existing data has been changed.
EVENT_CHANGED = 1,
## Previously existing data has been removed.
EVENT_REMOVED = 2,
};
> broxygen ignores doc comments
> -----------------------------
>
> Key: BIT-1483
> URL: https://bro-tracker.atlassian.net/browse/BIT-1483
> Project: Bro Issue Tracker
> Issue Type: Problem
> Components: Bro
> Reporter: Daniel Thayer
> Priority: Low
>
> Tried adding a documentation comment to an enum type, but broxygen ignores it.
> It seems the problem is the name "Event" (if I rename the type name, then
> the documentation comment is no longer ignored).
> Example from frameworks/input/main.bro:
> export {
> ## This line is ignored.
> type Event: enum {
> EVENT_NEW = 0,
> EVENT_CHANGED = 1,
> EVENT_REMOVED = 2,
> };
--
This message was sent by Atlassian JIRA
(v7.0.0-OD-06-002#70102)
More information about the bro-dev
mailing list