Improve coments on structures in trigger.c

Started by Yugo Nagataover 1 year ago2 messageshackers
Jump to latest
#1Yugo Nagata
nagata@sraoss.co.jp

Hi,

I found that comments in trigger.c describing fields of three different
structures in a comment block. I feel this is confusing because some
structure names are not explicitly mentioned there even though common field
names are used between structures. I've attached a patch to improve the comments
by splitting it to three blocks.

Regards,
Yugo Nagata

--
Yugo Nagata <nagata@sraoss.co.jp>

Attachments:

improve_comments_on_trigger_structure.patchtext/x-diff; name=improve_comments_on_trigger_structure.patchDownload+47-40
#2Philip Alger
paalger0@gmail.com
In reply to: Yugo Nagata (#1)
Re: Improve coments on structures in trigger.c

Hi Yugo,

I found that comments in trigger.c describing fields of three different
structures in a comment block.

That makes sense to me.

I've attached a patch to improve the comments
by splitting it to three blocks.

I think you could also move the comment beginning on:

* AfterTriggersData has the following fields:

To between:

typedef struct AfterTriggersTableData AfterTriggersTableData;

HERE

typedef struct AfterTriggersData

To keep it consistent with the other comments you moved around.