From bf324dc4631a78e1fd5ce3dcc37aaf9653ce2694 Mon Sep 17 00:00:00 2001 From: Duncan Roe Date: Mon, 27 Sep 2021 13:53:29 +1000 Subject: src: doc: Add \return for nflog_get_packet_hw() Also indicate that hw_addrlen has NBO in struct nfulnl_msg_packet_hw Signed-off-by: Duncan Roe Signed-off-by: Pablo Neira Ayuso --- src/libnetfilter_log.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/libnetfilter_log.c b/src/libnetfilter_log.c index 581f612..66669af 100644 --- a/src/libnetfilter_log.c +++ b/src/libnetfilter_log.c @@ -818,11 +818,15 @@ uint32_t nflog_get_physoutdev(struct nflog_data *nfad) * The nfulnl_msg_packet_hw structure is defined in libnetfilter_log.h as: * \verbatim struct nfulnl_msg_packet_hw { - uint16_t hw_addrlen; + uint16_t hw_addrlen; // Network Byte Order uint16_t _pad; uint8_t hw_addr[8]; } __attribute__ ((packed)); \endverbatim + * + * \return Pointer to struct nfulnl_msg_packet_hw from originating host + * or NULL if none available (e.g. locally-originated packet not for \b lo + * interface). */ struct nfulnl_msg_packet_hw *nflog_get_packet_hw(struct nflog_data *nfad) { -- cgit v1.2.3