diff options
author | Alberto Compagno <acompagn+fdio@cisco.com> | 2020-05-05 12:12:21 +0200 |
---|---|---|
committer | Alberto Compagno <acompagn+fdio@cisco.com> | 2020-05-06 16:44:34 +0200 |
commit | 485474ec0bcd5fd73743a040cbad326a458e6390 (patch) | |
tree | bca81977a66d96f9e0a29e2e522a64f93d7767f0 /hicn-plugin/src/utils.h | |
parent | 43d0ecbb1a1f7e1f72bf85441547b1678aed4350 (diff) |
[HICN-606] Added doxygen documentation
Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
Change-Id: If2bf7f4f310adf6adbbb9ea29eafcb2a0ee40d54
Diffstat (limited to 'hicn-plugin/src/utils.h')
-rw-r--r-- | hicn-plugin/src/utils.h | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/hicn-plugin/src/utils.h b/hicn-plugin/src/utils.h index ecad47e9b..689942ab6 100644 --- a/hicn-plugin/src/utils.h +++ b/hicn-plugin/src/utils.h @@ -18,6 +18,17 @@ #include "hicn.h" +/** + * @file + * + * Helpers to print hicn headers + */ + +/** + * @Brief Print the hicn name + * + * @param name hicn name to print + */ always_inline void hicn_print_name6 (hicn_name_t * name) { @@ -29,6 +40,11 @@ hicn_print_name6 (hicn_name_t * name) printf ("%s\n", s0); } +/** + * @Brief Print the ipv6 hicn header (src and dst address and port) + * + * @param hicn0 hICN header to print + */ always_inline void hicn_print6 (hicn_header_t * hicn0) { @@ -43,6 +59,11 @@ hicn_print6 (hicn_header_t * hicn0) vlib_cli_output (vm, "%s\n", s0); } +/** + * @Brief Print the ipv4 hicn header (src and dst address and port) + * + * @param hicn0 hICN header to print + */ always_inline void hicn_print4 (hicn_header_t * hicn0) { |