osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

wsutil: Add header files to Doxygen 

Add @file markers for wsutil
headers so that Doxygen will
generate documentation for them.
This commit is contained in:
Moshe Kaplan 2021-11-29 22:41:45 -05:00 committed by Wireshark GitLab Utility
parent 40016daeb3
commit e45ad9dcef
30 changed files with 51 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
wsutil/bits_count_ones.h
View File

@ -1,5 +1,4 @@
/* /** @file
* bits_count_ones.h
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>

3
wsutil/bits_ctz.h
View File

@ -1,5 +1,4 @@
/* /** @file
* bitz_ctz.h
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>

3
wsutil/color.h
View File

@ -1,4 +1,5 @@
/* color.h /** @file
*
* Definitions for colors * Definitions for colors
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
wsutil/epochs.h
View File

@ -1,4 +1,5 @@
/* epochs.h /** @file
*
* Definitions of epoch values for various absolute time types. * Definitions of epoch values for various absolute time types.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

4
wsutil/exported_pdu_tlvs.h
View File

@ -1,5 +1,5 @@
/* /** @file
* exported_pdu_tlvs.h *
* Definitions for exported_pdu TLVs * Definitions for exported_pdu TLVs
* Copyright 2013, Anders Broman <anders-broman@ericsson.com> * Copyright 2013, Anders Broman <anders-broman@ericsson.com>
* *

3
wsutil/glib-compat.h
View File

@ -1,4 +1,5 @@
/* glib-compat.h /** @file
*
* Definitions to provide some functions that are not present in older * Definitions to provide some functions that are not present in older
* GLIB versions (down to 2.22) * GLIB versions (down to 2.22)
* *

2
wsutil/inet_ipv4.h
View File

@ -1,4 +1,4 @@
/* inet_ipv4.h /** @file
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>

2
wsutil/inet_ipv6.h
View File

@ -1,4 +1,4 @@
/* inet_ipv6.h /** @file
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>

3
wsutil/jsmn.h
View File

@ -1,4 +1,5 @@
/* /** @file
Copyright (c) 2010 Serge A. Zaitsev Copyright (c) 2010 Serge A. Zaitsev
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

3
wsutil/netlink.h
View File

@ -1,4 +1,5 @@
/* netlink.h /** @file
*
* netlink-related definitions shared between libwireshark and other parts * netlink-related definitions shared between libwireshark and other parts
* *
* Copyright 2018, Martin Kaiser * Copyright 2018, Martin Kaiser

3
wsutil/pint.h
View File

@ -1,4 +1,5 @@
/* pint.h /** @file
*
* Definitions for extracting and translating integers safely and portably * Definitions for extracting and translating integers safely and portably
* via pointers. * via pointers.
* *

2
wsutil/pow2.h
View File

@ -1,4 +1,4 @@
/* ws_pow2.h /** @file
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>

3
wsutil/processes.h
View File

@ -1,4 +1,5 @@
/* processes.h /** @file
*
* Process utility definitions * Process utility definitions
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
wsutil/sign_ext.h
View File

@ -1,5 +1,4 @@
/* /** @file
* sign_ext.h
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>

3
wsutil/utf8_entities.h
View File

@ -1,4 +1,5 @@
/* utf8_entities.h /** @file
*
* Byte sequences for various UTF-8 entities * Byte sequences for various UTF-8 entities
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
wsutil/wmem/wmem-int.h
View File

@ -1,4 +1,5 @@
/* wmem-int.h /** @file
*
* Internal definitions for the Wireshark Memory Manager * Internal definitions for the Wireshark Memory Manager
* Copyright 2012, Evan Huus <eapache@gmail.com> * Copyright 2012, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem.h
View File

@ -1,4 +1,5 @@
/* wmem.h /** @file
*
* Definitions for the Wireshark Memory Manager * Definitions for the Wireshark Memory Manager
* Copyright 2012, Evan Huus <eapache@gmail.com> * Copyright 2012, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_allocator.h
View File

@ -1,4 +1,5 @@
/* wmem_allocator.h /** @file
*
* Definitions for the Wireshark Memory Manager Allocator * Definitions for the Wireshark Memory Manager Allocator
* Copyright 2012, Evan Huus <eapache@gmail.com> * Copyright 2012, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_allocator_block.h
View File

@ -1,4 +1,5 @@
/* wmem_allocator_block.h /** @file
*
* Definitions for the Wireshark Memory Manager Large-Block Allocator * Definitions for the Wireshark Memory Manager Large-Block Allocator
* Copyright 2012, Evan Huus <eapache@gmail.com> * Copyright 2012, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_allocator_block_fast.h
View File

@ -1,4 +1,5 @@
/* wmem_allocator_block_fast.h /** @file
*
* Definitions for the Wireshark Memory Manager Fast Large-Block Allocator * Definitions for the Wireshark Memory Manager Fast Large-Block Allocator
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
wsutil/wmem/wmem_allocator_simple.h
View File

@ -1,4 +1,5 @@
/* wmem_allocator_simple.h /** @file
*
* Definitions for the Wireshark Memory Manager Simple Allocator * Definitions for the Wireshark Memory Manager Simple Allocator
* Copyright 2012, Evan Huus <eapache@gmail.com> * Copyright 2012, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_allocator_strict.h
View File

@ -1,4 +1,5 @@
/* wmem_allocator_strict.h /** @file
*
* Definitions for the Wireshark Memory Manager Strict Allocator * Definitions for the Wireshark Memory Manager Strict Allocator
* Copyright 2012, Evan Huus <eapache@gmail.com> * Copyright 2012, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_map_int.h
View File

@ -1,4 +1,5 @@
/* wmem_map_int.h /** @file
*
* Definitions for the Wireshark Memory Manager Hash Map Internals * Definitions for the Wireshark Memory Manager Hash Map Internals
* Copyright 2014, Evan Huus <eapache@gmail.com> * Copyright 2014, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_queue.h
View File

@ -1,4 +1,5 @@
/* wmem_queue.h /** @file
*
* Definitions for the Wireshark Memory Manager Queue * Definitions for the Wireshark Memory Manager Queue
* Copyright 2013, Evan Huus <eapache@gmail.com> * Copyright 2013, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_tree-int.h
View File

@ -1,4 +1,5 @@
/* wmem_tree_internals.h /** @file
*
* Definitions for the Wireshark Memory Manager Red-Black Tree * Definitions for the Wireshark Memory Manager Red-Black Tree
* Copyright 2013, Evan Huus <eapache@gmail.com> * Copyright 2013, Evan Huus <eapache@gmail.com>
* *

3
wsutil/wmem/wmem_user_cb_int.h
View File

@ -1,4 +1,5 @@
/* wmem_user_cb_int.h /** @file
*
* Definitions for the Wireshark Memory Manager User Callback Internals * Definitions for the Wireshark Memory Manager User Callback Internals
* Copyright 2012, Evan Huus <eapache@gmail.com> * Copyright 2012, Evan Huus <eapache@gmail.com>
* *

2
wsutil/ws_cpuid.h
View File

@ -1,4 +1,4 @@
/* ws_cpuid.h /** @file
* Get the CPU info on x86 processors that support it * Get the CPU info on x86 processors that support it
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

2
wsutil/ws_mempbrk_int.h
View File

@ -1,4 +1,4 @@
/* ws_mempbrk_int.h /** @file
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>

3
wsutil/ws_return.h
View File

@ -1,4 +1,5 @@
/* /** @file
*
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs * Copyright 1998 Gerald Combs

2
wsutil/ws_roundup.h
View File

@ -1,4 +1,4 @@
/* ws_roundup.h /** @file
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org> * By Gerald Combs <gerald@wireshark.org>