Skip to content

Commit 4ea806b

Browse files
committed
UniRec output: added missing documentation
1 parent 32f03d5 commit 4ea806b

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

extra_plugins/output/unirec/src/map.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ struct map_rec {
8181
uint16_t id;
8282
/** Definition of the IE (MUST not be NULL) */
8383
const struct fds_iemgr_elem *def;
84+
/** Points to an element of list, NULL if field is not list. */
8485
struct map_ipfix_s *next;
8586
} ipfix; /**< IPFIX specific parameters */
8687

extra_plugins/output/unirec/src/translator.c

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ struct translator_rec {
7777
enum fds_iemgr_element_type type;
7878
/** Field semantic */
7979
enum fds_iemgr_element_semantic sem;
80+
/** Pointer to element of IPFIX list */
8081
struct tr_ipfix_s *next;
8182
} ipfix; /** IPFIX field identification */
8283

@@ -304,6 +305,10 @@ translate_int(translator_t *trans, const struct translator_rec *rec,
304305
return 0;
305306
}
306307

308+
/**
309+
* \brief Convert IPFIX list of uint elements to UniRec uint array
310+
* \copydetails translate_uint()
311+
*/
307312
static int
308313
translate_array_uint(translator_t *trans, const struct translator_rec *rec,
309314
const struct fds_drec_field *field)
@@ -354,6 +359,10 @@ translate_array_uint(translator_t *trans, const struct translator_rec *rec,
354359
return rc != FDS_OK;
355360
}
356361

362+
/**
363+
* \brief Convert IPFIX list of int elements to UniRec int array
364+
* \copydetails translate_uint()
365+
*/
357366
static int
358367
translate_array_int(translator_t *trans, const struct translator_rec *rec,
359368
const struct fds_drec_field *field)
@@ -405,7 +414,7 @@ translate_array_int(translator_t *trans, const struct translator_rec *rec,
405414
}
406415

407416
/**
408-
* \brief Convert IPFIX boolean to UniRec char/(un)signed integer
417+
* \brief Convert IPFIX list of bool elements to UniRec bool array
409418
* \copydetails translate_uint()
410419
*/
411420
static int
@@ -448,7 +457,7 @@ translate_array_bool(translator_t *trans, const struct translator_rec *rec,
448457
}
449458

450459
/**
451-
* \brief Convert IPFIX float to UniRec float
460+
* \brief Convert IPFIX list of float elements to UniRec float array
452461
* \copydetails translate_uint()
453462
*/
454463
static int
@@ -490,7 +499,7 @@ translate_array_float(translator_t *trans, const struct translator_rec *rec,
490499
}
491500

492501
/**
493-
* \brief Convert IPFIX IPv4/IPv6 address to UniRec IPv4/IPv6 address
502+
* \brief Convert IPFIX list of IPv4/IPv6 elements to UniRec IP array
494503
* \copydetails translate_uint()
495504
*/
496505
static int
@@ -522,7 +531,7 @@ translate_array_ip(translator_t *trans, const struct translator_rec *rec,
522531
}
523532

524533
/**
525-
* \brief Convert IPFIX MAC address to UniRec MAC address
534+
* \brief Convert IPFIX list of MAC elements to UniRec MAC array
526535
* \copydetails translate_uint()
527536
*/
528537
static int
@@ -547,7 +556,7 @@ translate_array_mac(translator_t *trans, const struct translator_rec *rec,
547556
}
548557

549558
/**
550-
* \brief Convert IPFIX timestamp to UniRec timestamp
559+
* \brief Convert IPFIX list of timestamp elements to UniRec timestamp array
551560
* \copydetails translate_uint()
552561
*/
553562
static int

0 commit comments

Comments
 (0)