epan: Add header files to Doxygen

Add @file markers for epan headers so that Doxygen will generate documentation for them.
2021-11-29 23:18:35 -05:00 · 2021-11-29 23:18:35 -05:00 · a523135202
parent fd5b5e3149
commit a523135202
54 changed files with 94 additions and 55 deletions
--- 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
 *
--- a/epan/afn.h
+++ b/epan/afn.h
@ -1,4 +1,5 @@
-/* afn.h
+/** @file
+ *
 * RFC 1700 address family numbers
 *
 * Wireshark - Network traffic analyzer
--- 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.
 *
--- 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>
 *
--- a/epan/arptypes.h
+++ b/epan/arptypes.h
@ -1,4 +1,5 @@
-/* arptypes.h
+/** @file
+ *
 * Declarations of ARP address types.
 *
 * Wireshark - Network traffic analyzer
--- 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>
--- 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).
 *
--- 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
--- 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
--- 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
--- 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)"
--- 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.
--- 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.
--- 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.
--- 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)
--- 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>
--- 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>
--- 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
--- 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>
--- 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
--- 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>
--- 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>
--- 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
--- 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
--- 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
--- 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
--- 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
--- a/epan/dtd.h
+++ b/epan/dtd.h
@ -1,5 +1,4 @@
-/*
- *  dtd.h
+/** @file
 *
 * XML dissector for Wireshark
 * DTD import declarations
--- 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
--- a/epan/exceptions.h
+++ b/epan/exceptions.h
@ -1,4 +1,5 @@
-/* exceptions.h
+/** @file
+ *
 * Wireshark's exceptions.
 *
 * Wireshark - Network traffic analyzer
--- 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
--- 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,
--- 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
--- 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
--- a/epan/llcsaps.h
+++ b/epan/llcsaps.h
@ -1,4 +1,5 @@
-/* llcsaps.h
+/** @file
+ *
 * Defines LLC SAP values.
 *
 * Wireshark - Network traffic analyzer
--- 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>
 *
--- 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>
--- a/epan/oui.h
+++ b/epan/oui.h
@ -1,4 +1,5 @@
-/* oui.h
+/** @file
+ *
 * Definitions of OUIs
 *
 * Wireshark - Network traffic analyzer
--- a/epan/params.h
+++ b/epan/params.h
@ -1,4 +1,5 @@
-/* params.h
+/** @file
+ *
 * Definitions for parameter handling routines
 *
 * Wireshark - Network traffic analyzer
--- 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
--- 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>
--- a/epan/ps.h
+++ b/epan/ps.h
@ -1,4 +1,5 @@
-/* ps.h
+/** @file
+ *
 * Definitions for generating PostScript(R) packet output.
 *
 * Gilbert Ramirez <gram@alumni.rice.edu>
--- a/epan/register.h
+++ b/epan/register.h
@ -1,4 +1,5 @@
-/* register.h
+/** @file
+ *
 * Definitions for protocol registration
 *
 * Wireshark - Network traffic analyzer
--- 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>
--- 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
--- a/epan/t35.h
+++ b/epan/t35.h
@ -1,4 +1,5 @@
-/* t35.h
+/** @file
+ *
 * T.35 and H.221 tables
 * 2003  Tomas Kukosa
 *
--- 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
--- 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
--- 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>
--- a/epan/ws_printf.h
+++ b/epan/ws_printf.h
@ -1,4 +1,5 @@
-/*
+/** @file
+ *
 * Wrappers for printf like functions.
 *
 * Wireshark - Network traffic analyzer
--- a/epan/wslua/lrexlib.h
+++ b/epan/wslua/lrexlib.h
@ -1,4 +1,4 @@
-/* common.h */
+/** @file */
 /*
 License of Lrexlib release
 --------------------------
--- a/epan/wslua/lrexlib_algo.h
+++ b/epan/wslua/lrexlib_algo.h
@ -1,4 +1,4 @@
-/* lrexlib_algo.h */
+/** @file */
 /*
 License of Lrexlib release
 --------------------------
--- 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/
 **
--- 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