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

epan: Add header files to Doxygen 

Add @file markers for epan
headers so that Doxygen will
generate documentation for them.
This commit is contained in:
Moshe Kaplan 2021-11-29 23:18:35 -05:00 committed by Wireshark GitLab Utility
parent fd5b5e3149
commit a523135202
54 changed files with 94 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
epan/addr_and_mask.h
View File

@ -1,4 +1,5 @@
/* addr_and_mask.h /** @file
*
* Declarations of routines to fetch IPv4 and IPv6 addresses from a tvbuff * 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 * and then mask out bits other than those covered by a prefix length
* *

3
epan/afn.h
View File

@ -1,4 +1,5 @@
/* afn.h /** @file
*
* RFC 1700 address family numbers * RFC 1700 address family numbers
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/aftypes.h
View File

@ -1,4 +1,5 @@
/* aftypes.h /** @file
*
* AF_ values on various OSes; they're used in some network protocols, as * AF_ values on various OSes; they're used in some network protocols, as
* well as in BSD DLT_NULL and DLT_LOOP headers. * well as in BSD DLT_NULL and DLT_LOOP headers.
* *

3
epan/arcnet_pids.h
View File

@ -1,4 +1,5 @@
/* arcnet_pids.h /** @file
*
* ARCNET protocol ID values * ARCNET protocol ID values
* Copyright 2001-2002, Peter Fales <ethereal@fales-lorenz.net> * Copyright 2001-2002, Peter Fales <ethereal@fales-lorenz.net>
* *

3
epan/arptypes.h
View File

@ -1,4 +1,5 @@
/* arptypes.h /** @file
*
* Declarations of ARP address types. * Declarations of ARP address types.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

2
epan/ax25_pids.h
View File

@ -1,4 +1,4 @@
/* ax25_pids.h /** @file
* *
* Protocol IDs for Amateur Packet Radio protocol dissection * 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> * Copyright 2005,2006,2007,2008,2009,2010,2012 R.W. Stearn <richard@rns-stearn.demon.co.uk>

3
epan/bridged_pids.h
View File

@ -1,4 +1,5 @@
/* bridged_pids.h /** @file
*
* Definitions of protocol IDs for the 00-80-C2 OUI, used for * Definitions of protocol IDs for the 00-80-C2 OUI, used for
* bridging various networks over ATM (RFC 2684) or Frame Relay (RFC 2427). * bridging various networks over ATM (RFC 2684) or Frame Relay (RFC 2427).
* *

3
epan/chdlctypes.h
View File

@ -1,4 +1,5 @@
/* chdlctypes.h /** @file
*
* Defines Cisco HDLC packet types that aren't just Ethernet types * Defines Cisco HDLC packet types that aren't just Ethernet types
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/cisco_pid.h
View File

@ -1,4 +1,5 @@
/* packet-cisco-oui.h /** @file
*
* Register an LLC dissector table for Cisco's OUI 00:00:0c * Register an LLC dissector table for Cisco's OUI 00:00:0c
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/conv_id.h
View File

@ -1,4 +1,5 @@
/* conv_id.h /** @file
*
* conv_id 2011 Robert Bullen * conv_id 2011 Robert Bullen
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

2
epan/crc8-tvb.h
View File

@ -1,4 +1,4 @@
/* crc8.h /** @file
* *
* Checks the checksum (FCS) of the 3G TS 27.010 Multiplexing protocol. * 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)" * The algorithm to check the FCS is described in "3G TS 27.010 V2.0.0 (1999-06)"

2
epan/crypt/dot11decrypt_debug.h
View File

@ -1,4 +1,4 @@
/* airpcap_debug.h /** @file
* *
* Copyright (c) 2006 CACE Technologies, Davis (California) * Copyright (c) 2006 CACE Technologies, Davis (California)
* All rights reserved. * All rights reserved.

2
epan/crypt/dot11decrypt_int.h
View File

@ -1,4 +1,4 @@
/* airpcap_int.h /** @file
* *
* Copyright (c) 2006 CACE Technologies, Davis (California) * Copyright (c) 2006 CACE Technologies, Davis (California)
* All rights reserved. * All rights reserved.

2
epan/crypt/dot11decrypt_interop.h
View File

@ -1,4 +1,4 @@
/* dot11decrypt_interop.h /** @file
* *
* Copyright (c) 2006 CACE Technologies, Davis (California) * Copyright (c) 2006 CACE Technologies, Davis (California)
* All rights reserved. * All rights reserved.

2
epan/crypt/dot11decrypt_util.h
View File

@ -1,4 +1,4 @@
/* dot11decrypt_util.h /** @file
* *
* Copyright (c) 2002-2005 Sam Leffler, Errno Consulting * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
* Copyright (c) 2006 CACE Technologies, Davis (California) * Copyright (c) 2006 CACE Technologies, Davis (California)

2
epan/crypt/kasumi.h
View File

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

3
epan/dccpservicecodes.h
View File

@ -1,4 +1,5 @@
/* dccpservicecodes.h /** @file
*
* Declarations of DCCP payload protocol IDs. * Declarations of DCCP payload protocol IDs.
* *
* Copyright 2021 by Thomas Dreibholz <dreibh [AT] simula.no> * Copyright 2021 by Thomas Dreibholz <dreibh [AT] simula.no>

3
epan/dfilter/dfilter-int.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/dfilter/dfunctions.h
View File

@ -1,4 +1,5 @@
/* /** @file
*
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer
* *
* Copyright 2006 Gilbert Ramirez <gram@alumni.rice.edu> * Copyright 2006 Gilbert Ramirez <gram@alumni.rice.edu>

3
epan/dfilter/dfvm.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/dfilter/drange.h
View File

@ -1,4 +1,5 @@
/* drange.h /** @file
*
* Routines for providing general range support to the dfilter library * Routines for providing general range support to the dfilter library
* *
* Copyright (c) 2000 by Ed Warnicke <hagbard@physics.rutgers.edu> * Copyright (c) 2000 by Ed Warnicke <hagbard@physics.rutgers.edu>

2
epan/dfilter/gencode.h
View File

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

3
epan/dfilter/semcheck.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/dfilter/sttype-function.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/dfilter/sttype-range.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/dfilter/sttype-set.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/dfilter/sttype-test.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/dtd.h
View File

@ -1,5 +1,4 @@
/* /** @file
* dtd.h
* *
* XML dissector for Wireshark * XML dissector for Wireshark
* DTD import declarations * DTD import declarations

3
epan/eapol_keydes_types.h
View File

@ -1,4 +1,5 @@
/* eapol_keydes_types.h /** @file
*
* Declarations of EAPOL Key Descriptor types * Declarations of EAPOL Key Descriptor types
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/exceptions.h
View File

@ -1,4 +1,5 @@
/* exceptions.h /** @file
*
* Wireshark's exceptions. * Wireshark's exceptions.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/ftypes/ftypes-int.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 2001 Gerald Combs * Copyright 2001 Gerald Combs

3
epan/garrayfix.h
View File

@ -1,4 +1,5 @@
/* garrayfix.h /** @file
*
* Macros to work around the "data" field of a GArray having type guint8 *, * 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 * rather than void *, so that, even though the GArray code should be
* ensuring that the data is aligned strictly enough for any data type, * ensuring that the data is aligned strictly enough for any data type,

3
epan/iax2_codec_type.h
View File

@ -1,4 +1,5 @@
/* iax2_codec_type.h /** @file
*
* Defines IAX2 codec types * Defines IAX2 codec types
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/lapd_sapi.h
View File

@ -1,4 +1,5 @@
/* lapd_sapi.h /** @file
*
* Declarations of LAPD SAPI values. * Declarations of LAPD SAPI values.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/llcsaps.h
View File

@ -1,4 +1,5 @@
/* llcsaps.h /** @file
*
* Defines LLC SAP values. * Defines LLC SAP values.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/nlpid.h
View File

@ -1,4 +1,5 @@
/* nlpid.h /** @file
*
* Definitions of OSI NLPIDs (Network Layer Protocol IDs) * Definitions of OSI NLPIDs (Network Layer Protocol IDs)
* Laurent Deniel <laurent.deniel@free.fr> * Laurent Deniel <laurent.deniel@free.fr>
* *

2
epan/osi-utils.h
View File

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

3
epan/oui.h
View File

@ -1,4 +1,5 @@
/* oui.h /** @file
*
* Definitions of OUIs * Definitions of OUIs
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/params.h
View File

@ -1,4 +1,5 @@
/* params.h /** @file
*
* Definitions for parameter handling routines * Definitions for parameter handling routines
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/pci-ids.h
View File

@ -1,4 +1,5 @@
/* pci-ids.h /** @file
*
* *
* By Caleb Chiu <caleb.chiu@macnica.com> * By Caleb Chiu <caleb.chiu@macnica.com>
* Copyright 2019 * Copyright 2019

2
epan/protobuf-helper.h
View File

@ -1,4 +1,4 @@
/* protobuf-helper.h /** @file
* *
* C Wrapper Layer of Protocol Buffers Language library. * C Wrapper Layer of Protocol Buffers Language library.
* Copyright 2019, Huang Qiangxiong <qiangxiong.huang@qq.com> * Copyright 2019, Huang Qiangxiong <qiangxiong.huang@qq.com>

3
epan/ps.h
View File

@ -1,4 +1,5 @@
/* ps.h /** @file
*
* Definitions for generating PostScript(R) packet output. * Definitions for generating PostScript(R) packet output.
* *
* Gilbert Ramirez <gram@alumni.rice.edu> * Gilbert Ramirez <gram@alumni.rice.edu>

3
epan/register.h
View File

@ -1,4 +1,5 @@
/* register.h /** @file
*
* Definitions for protocol registration * Definitions for protocol registration
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/slow_protocol_subtypes.h
View File

@ -1,4 +1,5 @@
/* slow_protocol_subtypes.h /** @file
*
* Defines subtypes for 802.3 "slow protocols" * Defines subtypes for 802.3 "slow protocols"
* *
* Copyright 2002 Steve Housley <steve_housley@3com.com> * Copyright 2002 Steve Housley <steve_housley@3com.com>

3
epan/sminmpec.h
View File

@ -1,4 +1,5 @@
/* sminmpec.h /** @file
*
* SMI Network Management Private Enterprise Codes for organizations * SMI Network Management Private Enterprise Codes for organizations
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/t35.h
View File

@ -1,4 +1,5 @@
/* t35.h /** @file
*
* T.35 and H.221 tables * T.35 and H.221 tables
* 2003 Tomas Kukosa * 2003 Tomas Kukosa
* *

3
epan/tap-voip.h
View File

@ -1,4 +1,5 @@
/* tap-voip.h /** @file
*
* VoIP packet tap interface 2007 Tomas Kukosa * VoIP packet tap interface 2007 Tomas Kukosa
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/time_fmt.h
View File

@ -1,4 +1,5 @@
/* time_fmt.h /** @file
*
* Definitions for various time display formats. * Definitions for various time display formats.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

3
epan/tvbuff_rdp.h
View File

@ -1,4 +1,5 @@
/* tvbuff_rdp.h /** @file
*
* Various decompression routines used by RDP * Various decompression routines used by RDP
* *
* Copyright (c) 2021 by David Fort <contact@hardening-consulting.com> * Copyright (c) 2021 by David Fort <contact@hardening-consulting.com>

3
epan/ws_printf.h
View File

@ -1,4 +1,5 @@
/* /** @file
*
* Wrappers for printf like functions. * Wrappers for printf like functions.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

2
epan/wslua/lrexlib.h
View File

@ -1,4 +1,4 @@
/* common.h */ /** @file */
/* /*
License of Lrexlib release License of Lrexlib release
-------------------------- --------------------------

2
epan/wslua/lrexlib_algo.h
View File

@ -1,4 +1,4 @@
/* lrexlib_algo.h */ /** @file */
/* /*
License of Lrexlib release License of Lrexlib release
-------------------------- --------------------------

2
epan/wslua/lua_bitop.h
View File

@ -1,4 +1,4 @@
/* /** @file
** Lua BitOp -- a bit operations library for Lua 5.1/5.2. ** Lua BitOp -- a bit operations library for Lua 5.1/5.2.
** http://bitop.luajit.org/ ** http://bitop.luajit.org/
** **

3
epan/x264_prt_id.h
View File

@ -1,4 +1,5 @@
/* x264_prt_id.h /** @file
*
* Definitions of X.264/ISO 11570 transport protocol IDs * Definitions of X.264/ISO 11570 transport protocol IDs
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer