diff options
| author | Moshe Kaplan <me@moshekaplan.com> | 2021-11-29 23:18:35 -0500 |
|---|---|---|
| committer | Wireshark GitLab Utility <gerald+gitlab-utility@wireshark.org> | 2021-11-30 08:46:49 +0000 |
| commit | a523135202846e147581a0b9496691c20f82d927 (patch) | |
| tree | 780e3e3c91a978e7523ee165a4baf410c1b903c4 /epan | |
| parent | fd5b5e3149bca86a44eeb312dad044d14a53c58d (diff) | |
epan: Add header files to Doxygen
Add @file markers for epan
headers so that Doxygen will
generate documentation for them.
Diffstat (limited to 'epan')
54 files changed, 94 insertions, 55 deletions
diff --git a/epan/addr_and_mask.h b/epan/addr_and_mask.h index c607d74f6b..bb807c19eb 100644 --- a/epan/addr_and_mask.h +++ b/epan/addr_and_mask.h @@ -1,4 +1,5 @@ -/* addr_and_mask.h +/** @file + * * Declarations of routines to fetch IPv4 and IPv6 addresses from a tvbuff * and then mask out bits other than those covered by a prefix length * diff --git a/epan/afn.h b/epan/afn.h index c63b0fe4e8..9bf475bf17 100644 --- a/epan/afn.h +++ b/epan/afn.h @@ -1,4 +1,5 @@ -/* afn.h +/** @file + * * RFC 1700 address family numbers * * Wireshark - Network traffic analyzer diff --git a/epan/aftypes.h b/epan/aftypes.h index a8c94bb69b..d822050f7c 100644 --- a/epan/aftypes.h +++ b/epan/aftypes.h @@ -1,4 +1,5 @@ -/* aftypes.h +/** @file + * * AF_ values on various OSes; they're used in some network protocols, as * well as in BSD DLT_NULL and DLT_LOOP headers. * diff --git a/epan/arcnet_pids.h b/epan/arcnet_pids.h index 4fc137c171..d318a246b4 100644 --- a/epan/arcnet_pids.h +++ b/epan/arcnet_pids.h @@ -1,4 +1,5 @@ -/* arcnet_pids.h +/** @file + * * ARCNET protocol ID values * Copyright 2001-2002, Peter Fales <ethereal@fales-lorenz.net> * diff --git a/epan/arptypes.h b/epan/arptypes.h index ae73053215..1670c33ccd 100644 --- a/epan/arptypes.h +++ b/epan/arptypes.h @@ -1,4 +1,5 @@ -/* arptypes.h +/** @file + * * Declarations of ARP address types. * * Wireshark - Network traffic analyzer diff --git a/epan/ax25_pids.h b/epan/ax25_pids.h index b590585b95..e6a499e14c 100644 --- a/epan/ax25_pids.h +++ b/epan/ax25_pids.h @@ -1,4 +1,4 @@ -/* ax25_pids.h +/** @file * * Protocol IDs for Amateur Packet Radio protocol dissection * Copyright 2005,2006,2007,2008,2009,2010,2012 R.W. Stearn <richard@rns-stearn.demon.co.uk> diff --git a/epan/bridged_pids.h b/epan/bridged_pids.h index c97ba5d4d7..566b442a6d 100644 --- a/epan/bridged_pids.h +++ b/epan/bridged_pids.h @@ -1,4 +1,5 @@ -/* bridged_pids.h +/** @file + * * Definitions of protocol IDs for the 00-80-C2 OUI, used for * bridging various networks over ATM (RFC 2684) or Frame Relay (RFC 2427). * diff --git a/epan/chdlctypes.h b/epan/chdlctypes.h index f37e6f0c0b..3c6a96c650 100644 --- a/epan/chdlctypes.h +++ b/epan/chdlctypes.h @@ -1,4 +1,5 @@ -/* chdlctypes.h +/** @file + * * Defines Cisco HDLC packet types that aren't just Ethernet types * * Wireshark - Network traffic analyzer diff --git a/epan/cisco_pid.h b/epan/cisco_pid.h index 6c93b3b799..45f57a255a 100644 --- a/epan/cisco_pid.h +++ b/epan/cisco_pid.h @@ -1,4 +1,5 @@ -/* packet-cisco-oui.h +/** @file + * * Register an LLC dissector table for Cisco's OUI 00:00:0c * * Wireshark - Network traffic analyzer diff --git a/epan/conv_id.h b/epan/conv_id.h index 22ec6c35b3..0e4c753362 100644 --- a/epan/conv_id.h +++ b/epan/conv_id.h @@ -1,4 +1,5 @@ -/* conv_id.h +/** @file + * * conv_id 2011 Robert Bullen * * Wireshark - Network traffic analyzer diff --git a/epan/crc8-tvb.h b/epan/crc8-tvb.h index fdbcdfead9..34892d72ba 100644 --- a/epan/crc8-tvb.h +++ b/epan/crc8-tvb.h @@ -1,4 +1,4 @@ -/* crc8.h +/** @file * * Checks the checksum (FCS) of the 3G TS 27.010 Multiplexing protocol. * The algorithm to check the FCS is described in "3G TS 27.010 V2.0.0 (1999-06)" diff --git a/epan/crypt/dot11decrypt_debug.h b/epan/crypt/dot11decrypt_debug.h index 351c61e3d7..b9bf08b625 100644 --- a/epan/crypt/dot11decrypt_debug.h +++ b/epan/crypt/dot11decrypt_debug.h @@ -1,4 +1,4 @@ -/* airpcap_debug.h +/** @file * * Copyright (c) 2006 CACE Technologies, Davis (California) * All rights reserved. diff --git a/epan/crypt/dot11decrypt_int.h b/epan/crypt/dot11decrypt_int.h index e582179a8a..0507db4ba2 100644 --- a/epan/crypt/dot11decrypt_int.h +++ b/epan/crypt/dot11decrypt_int.h @@ -1,4 +1,4 @@ -/* airpcap_int.h +/** @file * * Copyright (c) 2006 CACE Technologies, Davis (California) * All rights reserved. diff --git a/epan/crypt/dot11decrypt_interop.h b/epan/crypt/dot11decrypt_interop.h index 8951a2a860..7a69383cf2 100644 --- a/epan/crypt/dot11decrypt_interop.h +++ b/epan/crypt/dot11decrypt_interop.h @@ -1,4 +1,4 @@ -/* dot11decrypt_interop.h +/** @file * * Copyright (c) 2006 CACE Technologies, Davis (California) * All rights reserved. diff --git a/epan/crypt/dot11decrypt_util.h b/epan/crypt/dot11decrypt_util.h index c368a533ea..c3a82faae0 100644 --- a/epan/crypt/dot11decrypt_util.h +++ b/epan/crypt/dot11decrypt_util.h @@ -1,4 +1,4 @@ -/* dot11decrypt_util.h +/** @file * * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting * Copyright (c) 2006 CACE Technologies, Davis (California) diff --git a/epan/crypt/kasumi.h b/epan/crypt/kasumi.h index 4ef82519d0..e3fcfd7c33 100644 --- a/epan/crypt/kasumi.h +++ b/epan/crypt/kasumi.h @@ -1,4 +1,4 @@ -/* kasumi.h +/** @file * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> diff --git a/epan/dccpservicecodes.h b/epan/dccpservicecodes.h index 016ccd53c4..f2c3d430b0 100644 --- a/epan/dccpservicecodes.h +++ b/epan/dccpservicecodes.h @@ -1,4 +1,5 @@ -/* dccpservicecodes.h +/** @file + * * Declarations of DCCP payload protocol IDs. * * Copyright 2021 by Thomas Dreibholz <dreibh [AT] simula.no> diff --git a/epan/dfilter/dfilter-int.h b/epan/dfilter/dfilter-int.h index 124d2b8c27..451226907c 100644 --- a/epan/dfilter/dfilter-int.h +++ b/epan/dfilter/dfilter-int.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/dfilter/dfunctions.h b/epan/dfilter/dfunctions.h index 93efb8d43e..9aa2fdaa50 100644 --- a/epan/dfilter/dfunctions.h +++ b/epan/dfilter/dfunctions.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * * Copyright 2006 Gilbert Ramirez <gram@alumni.rice.edu> diff --git a/epan/dfilter/dfvm.h b/epan/dfilter/dfvm.h index 43ab12c9cd..b9d87377c6 100644 --- a/epan/dfilter/dfvm.h +++ b/epan/dfilter/dfvm.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/dfilter/drange.h b/epan/dfilter/drange.h index 64d64fe566..d3939e0eaa 100644 --- a/epan/dfilter/drange.h +++ b/epan/dfilter/drange.h @@ -1,4 +1,5 @@ -/* drange.h +/** @file + * * Routines for providing general range support to the dfilter library * * Copyright (c) 2000 by Ed Warnicke <hagbard@physics.rutgers.edu> diff --git a/epan/dfilter/gencode.h b/epan/dfilter/gencode.h index 13e838889b..e9857da26e 100644 --- a/epan/dfilter/gencode.h +++ b/epan/dfilter/gencode.h @@ -1,4 +1,4 @@ -/* gencode.h +/** @file * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> diff --git a/epan/dfilter/semcheck.h b/epan/dfilter/semcheck.h index 72b969a474..8c29281982 100644 --- a/epan/dfilter/semcheck.h +++ b/epan/dfilter/semcheck.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/dfilter/sttype-function.h b/epan/dfilter/sttype-function.h index c756cee4b4..68b9c57d4d 100644 --- a/epan/dfilter/sttype-function.h +++ b/epan/dfilter/sttype-function.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/dfilter/sttype-range.h b/epan/dfilter/sttype-range.h index 5c6ef4b58e..09ad10bc9c 100644 --- a/epan/dfilter/sttype-range.h +++ b/epan/dfilter/sttype-range.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/dfilter/sttype-set.h b/epan/dfilter/sttype-set.h index 53ac6b463f..890e15b03a 100644 --- a/epan/dfilter/sttype-set.h +++ b/epan/dfilter/sttype-set.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/dfilter/sttype-test.h b/epan/dfilter/sttype-test.h index 217007484a..0749f7eb0b 100644 --- a/epan/dfilter/sttype-test.h +++ b/epan/dfilter/sttype-test.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/dtd.h b/epan/dtd.h index 10a2750f9f..053d3efa72 100644 --- a/epan/dtd.h +++ b/epan/dtd.h @@ -1,5 +1,4 @@ -/* - * dtd.h +/** @file * * XML dissector for Wireshark * DTD import declarations diff --git a/epan/eapol_keydes_types.h b/epan/eapol_keydes_types.h index d05af147f4..438ff13fb1 100644 --- a/epan/eapol_keydes_types.h +++ b/epan/eapol_keydes_types.h @@ -1,4 +1,5 @@ -/* eapol_keydes_types.h +/** @file + * * Declarations of EAPOL Key Descriptor types * * Wireshark - Network traffic analyzer diff --git a/epan/exceptions.h b/epan/exceptions.h index 109ea60b15..71ebbeec15 100644 --- a/epan/exceptions.h +++ b/epan/exceptions.h @@ -1,4 +1,5 @@ -/* exceptions.h +/** @file + * * Wireshark's exceptions. * * Wireshark - Network traffic analyzer diff --git a/epan/ftypes/ftypes-int.h b/epan/ftypes/ftypes-int.h index b171dc0525..548c1422fc 100644 --- a/epan/ftypes/ftypes-int.h +++ b/epan/ftypes/ftypes-int.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> * Copyright 2001 Gerald Combs diff --git a/epan/garrayfix.h b/epan/garrayfix.h index c00d00dd03..f5535932fa 100644 --- a/epan/garrayfix.h +++ b/epan/garrayfix.h @@ -1,4 +1,5 @@ -/* garrayfix.h +/** @file + * * Macros to work around the "data" field of a GArray having type guint8 *, * rather than void *, so that, even though the GArray code should be * ensuring that the data is aligned strictly enough for any data type, diff --git a/epan/iax2_codec_type.h b/epan/iax2_codec_type.h index 84465b02c3..ff03d1669e 100644 --- a/epan/iax2_codec_type.h +++ b/epan/iax2_codec_type.h @@ -1,4 +1,5 @@ -/* iax2_codec_type.h +/** @file + * * Defines IAX2 codec types * * Wireshark - Network traffic analyzer diff --git a/epan/lapd_sapi.h b/epan/lapd_sapi.h index 561efd7576..3729a3483d 100644 --- a/epan/lapd_sapi.h +++ b/epan/lapd_sapi.h @@ -1,4 +1,5 @@ -/* lapd_sapi.h +/** @file + * * Declarations of LAPD SAPI values. * * Wireshark - Network traffic analyzer diff --git a/epan/llcsaps.h b/epan/llcsaps.h index 70433d29be..270e5fdffc 100644 --- a/epan/llcsaps.h +++ b/epan/llcsaps.h @@ -1,4 +1,5 @@ -/* llcsaps.h +/** @file + * * Defines LLC SAP values. * * Wireshark - Network traffic analyzer diff --git a/epan/nlpid.h b/epan/nlpid.h index 895b5039e6..93b3f2c9d6 100644 --- a/epan/nlpid.h +++ b/epan/nlpid.h @@ -1,4 +1,5 @@ -/* nlpid.h +/** @file + * * Definitions of OSI NLPIDs (Network Layer Protocol IDs) * Laurent Deniel <laurent.deniel@free.fr> * diff --git a/epan/osi-utils.h b/epan/osi-utils.h index 8fa57340ac..d98b454fe8 100644 --- a/epan/osi-utils.h +++ b/epan/osi-utils.h @@ -1,4 +1,4 @@ -/* osi-utils.h +/** @file * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> diff --git a/epan/oui.h b/epan/oui.h index 123b6c95e9..9a1823cef0 100644 --- a/epan/oui.h +++ b/epan/oui.h @@ -1,4 +1,5 @@ -/* oui.h +/** @file + * * Definitions of OUIs * * Wireshark - Network traffic analyzer diff --git a/epan/params.h b/epan/params.h index d2fbc14e62..8ccf8615b5 100644 --- a/epan/params.h +++ b/epan/params.h @@ -1,4 +1,5 @@ -/* params.h +/** @file + * * Definitions for parameter handling routines * * Wireshark - Network traffic analyzer diff --git a/epan/pci-ids.h b/epan/pci-ids.h index 4bb67920a4..898148809a 100644 --- a/epan/pci-ids.h +++ b/epan/pci-ids.h @@ -1,4 +1,5 @@ -/* pci-ids.h +/** @file + * * * By Caleb Chiu <caleb.chiu@macnica.com> * Copyright 2019 diff --git a/epan/protobuf-helper.h b/epan/protobuf-helper.h index 20fb36e9e6..623a980d06 100644 --- a/epan/protobuf-helper.h +++ b/epan/protobuf-helper.h @@ -1,4 +1,4 @@ -/* protobuf-helper.h +/** @file * * C Wrapper Layer of Protocol Buffers Language library. * Copyright 2019, Huang Qiangxiong <qiangxiong.huang@qq.com> @@ -1,4 +1,5 @@ -/* ps.h +/** @file + * * Definitions for generating PostScript(R) packet output. * * Gilbert Ramirez <gram@alumni.rice.edu> diff --git a/epan/register.h b/epan/register.h index f383bf3afb..2eaa5ae008 100644 --- a/epan/register.h +++ b/epan/register.h @@ -1,4 +1,5 @@ -/* register.h +/** @file + * * Definitions for protocol registration * * Wireshark - Network traffic analyzer diff --git a/epan/slow_protocol_subtypes.h b/epan/slow_protocol_subtypes.h index 22dca1a226..5174939fb6 100644 --- a/epan/slow_protocol_subtypes.h +++ b/epan/slow_protocol_subtypes.h @@ -1,4 +1,5 @@ -/* slow_protocol_subtypes.h +/** @file + * * Defines subtypes for 802.3 "slow protocols" * * Copyright 2002 Steve Housley <steve_housley@3com.com> diff --git a/epan/sminmpec.h b/epan/sminmpec.h index 2be4d801c7..29ade30e06 100644 --- a/epan/sminmpec.h +++ b/epan/sminmpec.h @@ -1,4 +1,5 @@ -/* sminmpec.h +/** @file + * * SMI Network Management Private Enterprise Codes for organizations * * Wireshark - Network traffic analyzer diff --git a/epan/t35.h b/epan/t35.h index 2076542feb..f50001b2ec 100644 --- a/epan/t35.h +++ b/epan/t35.h @@ -1,4 +1,5 @@ -/* t35.h +/** @file + * * T.35 and H.221 tables * 2003 Tomas Kukosa * diff --git a/epan/tap-voip.h b/epan/tap-voip.h index 236a4a9655..8aa2a346e3 100644 --- a/epan/tap-voip.h +++ b/epan/tap-voip.h @@ -1,4 +1,5 @@ -/* tap-voip.h +/** @file + * * VoIP packet tap interface 2007 Tomas Kukosa * * Wireshark - Network traffic analyzer diff --git a/epan/time_fmt.h b/epan/time_fmt.h index f31571150d..b353d4a26f 100644 --- a/epan/time_fmt.h +++ b/epan/time_fmt.h @@ -1,4 +1,5 @@ -/* time_fmt.h +/** @file + * * Definitions for various time display formats. * * Wireshark - Network traffic analyzer diff --git a/epan/tvbuff_rdp.h b/epan/tvbuff_rdp.h index ea5db33284..69eba4a1df 100644 --- a/epan/tvbuff_rdp.h +++ b/epan/tvbuff_rdp.h @@ -1,4 +1,5 @@ -/* tvbuff_rdp.h +/** @file + * * Various decompression routines used by RDP * * Copyright (c) 2021 by David Fort <contact@hardening-consulting.com> diff --git a/epan/ws_printf.h b/epan/ws_printf.h index d84df646b5..dbc5a5de92 100644 --- a/epan/ws_printf.h +++ b/epan/ws_printf.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Wrappers for printf like functions. * * Wireshark - Network traffic analyzer diff --git a/epan/wslua/lrexlib.h b/epan/wslua/lrexlib.h index 7c8d023770..198fb615f8 100644 --- a/epan/wslua/lrexlib.h +++ b/epan/wslua/lrexlib.h @@ -1,4 +1,4 @@ -/* common.h */ +/** @file */ /* License of Lrexlib release -------------------------- diff --git a/epan/wslua/lrexlib_algo.h b/epan/wslua/lrexlib_algo.h index c4f06f029f..f2f714904c 100644 --- a/epan/wslua/lrexlib_algo.h +++ b/epan/wslua/lrexlib_algo.h @@ -1,4 +1,4 @@ -/* lrexlib_algo.h */ +/** @file */ /* License of Lrexlib release -------------------------- diff --git a/epan/wslua/lua_bitop.h b/epan/wslua/lua_bitop.h index 652ffaa948..17c242db62 100644 --- a/epan/wslua/lua_bitop.h +++ b/epan/wslua/lua_bitop.h @@ -1,4 +1,4 @@ -/* +/** @file ** Lua BitOp -- a bit operations library for Lua 5.1/5.2. ** http://bitop.luajit.org/ ** diff --git a/epan/x264_prt_id.h b/epan/x264_prt_id.h index da975a2a52..71d1a34ef1 100644 --- a/epan/x264_prt_id.h +++ b/epan/x264_prt_id.h @@ -1,4 +1,5 @@ -/* x264_prt_id.h +/** @file + * * Definitions of X.264/ISO 11570 transport protocol IDs * * Wireshark - Network traffic analyzer |