wiretap: Add header files to Doxygen

Add @file markers for wiretap headers so that Doxygen will generate documentation for them.
2021-11-29 21:59:23 -05:00 · 2021-11-29 21:59:23 -05:00 · 34454a5037
parent 504de90a3c
commit 34454a5037
74 changed files with 80 additions and 74 deletions
--- a/wiretap/5views.h
+++ b/wiretap/5views.h
@ -1,4 +1,4 @@
-/* 5views.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/aethra.h
+++ b/wiretap/aethra.h
@ -1,4 +1,4 @@
-/* aethra.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/ascend-int.h
+++ b/wiretap/ascend-int.h
@ -1,4 +1,5 @@
-/* ascend-int.h
+/** @file
+ *
 * Definitions for routines common to multiple modules in the Lucent/Ascend
 * capture file reading code code, but not used outside that code.
 *
--- a/wiretap/ascendtext.h
+++ b/wiretap/ascendtext.h
@ -1,4 +1,4 @@
-/* ascend.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/atm.h
+++ b/wiretap/atm.h
@ -1,4 +1,4 @@
-/* atm.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/ber.h
+++ b/wiretap/ber.h
@ -1,4 +1,4 @@
-/* ber.h
+/** @file
 *
 * Basic Encoding Rules (BER) file reading
 *
--- a/wiretap/blf.h
+++ b/wiretap/blf.h
@ -1,4 +1,4 @@
-/* blf.h
+/** @file
 *
 * BLF file format decoder for the Wiretap library.
 *
--- a/wiretap/btsnoop.h
+++ b/wiretap/btsnoop.h
@ -1,4 +1,4 @@
-/* btsnoop.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/busmaster.h
+++ b/wiretap/busmaster.h
@ -1,4 +1,4 @@
-/* busmaster.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/busmaster_priv.h
+++ b/wiretap/busmaster_priv.h
@ -1,4 +1,4 @@
-/* busmaster_priv.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/camins.h
+++ b/wiretap/camins.h
@ -1,4 +1,4 @@
-/* camins.h
+/** @file
 *
 * File format support for Rabbit Labs CAM Inspector files
 * Copyright (c) 2013 by Martin Kaiser <martin@kaiser.cx>
--- a/wiretap/candump.h
+++ b/wiretap/candump.h
@ -1,4 +1,4 @@
-/* candump.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/candump_priv.h
+++ b/wiretap/candump_priv.h
@ -1,4 +1,4 @@
-/* candump-priv.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/capsa.h
+++ b/wiretap/capsa.h
@ -1,4 +1,4 @@
-/* capsa.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/catapult_dct2000.h
+++ b/wiretap/catapult_dct2000.h
@ -1,4 +1,4 @@
-/* catapult_dct2000.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/commview.h
+++ b/wiretap/commview.h
@ -1,4 +1,4 @@
-/* commview.h
+/** @file
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
--- a/wiretap/cosine.h
+++ b/wiretap/cosine.h
@ -1,4 +1,4 @@
-/* cosine.h
+/** @file
 *
 * CoSine IPNOS L2 debug output parsing
 * Copyright (c) 2002 by Motonori Shindo <motonori@shin.do>
--- a/wiretap/csids.h
+++ b/wiretap/csids.h
@ -1,4 +1,4 @@
- /* csids.h
+/** @file
 *
 * Copyright (c) 2000 by Mike Hall <mlh@io.com>
 * Copyright (c) Cisco Systems
--- a/wiretap/daintree-sna.h
+++ b/wiretap/daintree-sna.h
@ -1,4 +1,4 @@
-/* daintree-sna.h
+/** @file
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
--- a/wiretap/dbs-etherwatch.h
+++ b/wiretap/dbs-etherwatch.h
@ -1,4 +1,4 @@
-/* dbs-etherwatch.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/dct3trace.h
+++ b/wiretap/dct3trace.h
@ -1,4 +1,4 @@
-/* dct3trace.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/dpa400.h
+++ b/wiretap/dpa400.h
@ -1,4 +1,4 @@
-/* dpa400.h
+/** @file
 *
 * Copyright 2018, Dirk Eibach, Guntermann & Drunck GmbH <dirk.eibach@gdsys.cc>
 *
--- a/wiretap/erf-common.h
+++ b/wiretap/erf-common.h
@ -1,4 +1,4 @@
-/*
+/** @file
 *
 * Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
 * All rights reserved.
--- a/wiretap/erf.h
+++ b/wiretap/erf.h
@ -1,4 +1,4 @@
-/*
+/** @file
 *
 * Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
 * All rights reserved.
--- a/wiretap/erf_record.h
+++ b/wiretap/erf_record.h
@ -1,4 +1,4 @@
-/*
+/** @file
 *
 * Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
 * All rights reserved.
--- a/wiretap/eri_enb_log.h
+++ b/wiretap/eri_enb_log.h
@ -1,4 +1,4 @@
-/* eri_enb_log.h
+/** @file
 *
 * Ericsson eNode-B raw log file format decoder for the Wiretap library.
 *
--- a/wiretap/eyesdn.h
+++ b/wiretap/eyesdn.h
@ -1,4 +1,4 @@
-/* eyesdn.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/hcidump.h
+++ b/wiretap/hcidump.h
@ -1,4 +1,4 @@
-/* hcidump.h
+/** @file
 *
 * Copyright (c) 2003 by Marcel Holtmann <marcel@holtmann.org>
 *
--- a/wiretap/i4b_trace.h
+++ b/wiretap/i4b_trace.h
@ -1,4 +1,5 @@
-/*
+/** @file
+ *
 * Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-2-Clause
--- a/wiretap/i4btrace.h
+++ b/wiretap/i4btrace.h
@ -1,4 +1,4 @@
-/* i4btrace.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1999 by Bert Driehuis <driehuis@playbeing.org>
--- a/wiretap/ipfix.h
+++ b/wiretap/ipfix.h
@ -1,4 +1,4 @@
-/* ipfix.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 2010 by Hadriel Kaplan <hadrielk@yahoo.com>
--- a/wiretap/iptrace.h
+++ b/wiretap/iptrace.h
@ -1,4 +1,4 @@
-/* iptrace.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/iseries.h
+++ b/wiretap/iseries.h
@ -1,4 +1,4 @@
-/* iseries.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 2005 by Martin Warnes <martin@warnes.homeip.net>
--- a/wiretap/json.h
+++ b/wiretap/json.h
@ -1,4 +1,4 @@
-/* json.h
+/** @file
 *
 * Copyright 2015, Dario Lombardo <lomato@gmail.com>
 *
--- a/wiretap/k12.h
+++ b/wiretap/k12.h
@ -1,4 +1,4 @@
-/* k12.c
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/lanalyzer.h
+++ b/wiretap/lanalyzer.h
@ -1,4 +1,4 @@
-/* lanalyzer.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/libpcap.h
+++ b/wiretap/libpcap.h
@ -1,4 +1,4 @@
-/* libpcap.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/log3gpp.h
+++ b/wiretap/log3gpp.h
@ -1,4 +1,4 @@
-/* log_3gpp.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/logcat.h
+++ b/wiretap/logcat.h
@ -1,4 +1,4 @@
-/* logcat.h
+/** @file
 *
 * Copyright 2014, Michal Labedzki for Tieto Corporation
 *
--- a/wiretap/logcat_text.h
+++ b/wiretap/logcat_text.h
@ -1,4 +1,4 @@
-/* logcat_text.h
+/** @file
 *
 * Copyright 2014, Michal Orynicz for Tieto Corporation
 *
--- a/wiretap/mime_file.h
+++ b/wiretap/mime_file.h
@ -1,4 +1,4 @@
-/* mime_file.h
+/** @file
 *
 * MIME file format decoder for the Wiretap library.
 *
--- a/wiretap/mp2t.h
+++ b/wiretap/mp2t.h
@ -1,4 +1,4 @@
-/* mp2t.h
+/** @file
 *
 * ISO/IEC 13818-1 MPEG2-TS file format decoder for the Wiretap library.
 * Written by Weston Schmidt <weston_schmidt@alumni.purdue.edu>
--- a/wiretap/mp4.h
+++ b/wiretap/mp4.h
@ -1,4 +1,4 @@
-/* mp4.h
+/** @file
 *
 * MP4 (ISO/IEC 14496-12) file format decoder for the Wiretap library.
 *
--- a/wiretap/mpeg.h
+++ b/wiretap/mpeg.h
@ -1,4 +1,4 @@
-/* mpeg.h
+/** @file
 *
 * MPEG file format decoder for the Wiretap library.
 * Written by Shaun Jackman <sjackman@gmail.com>
--- a/wiretap/mplog.h
+++ b/wiretap/mplog.h
@ -1,4 +1,4 @@
-/* mplog.h
+/** @file
 *
 * File format support for Micropross mplog files
 * Copyright (c) 2016 by Martin Kaiser <martin@kaiser.cx>
--- a/wiretap/netmon.h
+++ b/wiretap/netmon.h
@ -1,4 +1,4 @@
-/* netmon.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/netscaler.h
+++ b/wiretap/netscaler.h
@ -1,4 +1,4 @@
-/* netscaler.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 2006 by Ravi Kondamuru <Ravi.Kondamuru@citrix.com>
--- a/wiretap/netscreen.h
+++ b/wiretap/netscreen.h
@ -1,4 +1,4 @@
-/* netscreen.h
+/** @file
 *
 * Juniper NetScreen snoop output parser
 * Created by re-using a lot of code from cosine.c
--- a/wiretap/nettl.h
+++ b/wiretap/nettl.h
@ -1,4 +1,4 @@
-/* nettl.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/nettrace_3gpp_32_423.h
+++ b/wiretap/nettrace_3gpp_32_423.h
@ -1,4 +1,4 @@
-/* nettrace_3gpp_32_423.h
+/** @file
 *
 * MIME file format decoder for the Wiretap library.
 *
--- a/wiretap/netxray.h
+++ b/wiretap/netxray.h
@ -1,4 +1,4 @@
-/* netxray.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/ngsniffer.h
+++ b/wiretap/ngsniffer.h
@ -1,4 +1,4 @@
-/* ngsniffer.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/observer.h
+++ b/wiretap/observer.h
@ -1,4 +1,4 @@
-/***************************************************************************
+/** @file
                          observer.h  -  description
                             -------------------
    begin                : Wed Oct 29 2003
--- a/wiretap/packetlogger.h
+++ b/wiretap/packetlogger.h
@ -1,4 +1,4 @@
-/* packetlogger.h
+/** @file
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
--- a/wiretap/pcap-common.h
+++ b/wiretap/pcap-common.h
@ -1,4 +1,5 @@
-/* pcap-common.h
+/** @file
+ *
 * Declarations for code common to pcap and pcapng file formats
 *
 * Wiretap Library
--- a/wiretap/pcapng.h
+++ b/wiretap/pcapng.h
@ -1,4 +1,4 @@
-/* pcapng.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/peekclassic.h
+++ b/wiretap/peekclassic.h
@ -1,4 +1,4 @@
-/* peekclassic.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/peektagged.h
+++ b/wiretap/peektagged.h
@ -1,4 +1,4 @@
-/* peektagged.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/pppdump.h
+++ b/wiretap/pppdump.h
@ -1,4 +1,4 @@
-/* pppdump.h
+/** @file
 *
 * Copyright (c) 2000 by Gilbert Ramirez <gram@alumni.rice.edu>
 *
--- a/wiretap/radcom.h
+++ b/wiretap/radcom.h
@ -1,4 +1,4 @@
-/* radcom.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/required_file_handlers.h
+++ b/wiretap/required_file_handlers.h
@ -1,4 +1,5 @@
-/* required_file_handlers.h
+/** @file
+ *
 * Functions and variables defined by required file handlers (pcap,
 * nanosecond pcap, pcapng).
 *
--- a/wiretap/rfc7468.h
+++ b/wiretap/rfc7468.h
@ -1,4 +1,4 @@
-/* rfc7468.h
+/** @file
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
--- a/wiretap/ruby_marshal.h
+++ b/wiretap/ruby_marshal.h
@ -1,4 +1,4 @@
-/* ruby_marshal.h
+/** @file
 *
 * Copyright 2018, Dario Lombardo <lomato@gmail.com>
 *
--- a/wiretap/secrets-types.h
+++ b/wiretap/secrets-types.h
@ -1,4 +1,5 @@
-/* secrets-types.h
+/** @file
+ *
 * Identifiers used by Decryption Secrets Blocks (DSB).
 *
 * Wireshark - Network traffic analyzer
--- a/wiretap/snoop.h
+++ b/wiretap/snoop.h
@ -1,4 +1,4 @@
-/* snoop.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/socketcan.h
+++ b/wiretap/socketcan.h
@ -1,4 +1,4 @@
-/* socketcan.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/stanag4607.h
+++ b/wiretap/stanag4607.h
@ -1,4 +1,4 @@
-/* stanag4607.h
+/** @file
 *
 * STANAG 4607 file reading
 *
--- a/wiretap/systemd_journal.h
+++ b/wiretap/systemd_journal.h
@ -1,4 +1,4 @@
-/* systemd_journal.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/tnef.h
+++ b/wiretap/tnef.h
@ -1,4 +1,4 @@
-/* tnef.h
+/** @file
 *
 * Transport-Neutral Encapsulation Format (TNEF) file reading
 *
--- a/wiretap/toshiba.h
+++ b/wiretap/toshiba.h
@ -1,4 +1,4 @@
-/* toshiba.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
--- a/wiretap/visual.h
+++ b/wiretap/visual.h
@ -1,4 +1,4 @@
-/* visual.h
+/** @file
 *
 * File read write routines for Visual Networks .cap files.
 * Copyright 2001, Tom Nisbet  tnisbet@visualnetworks.com
--- a/wiretap/vms.h
+++ b/wiretap/vms.h
@ -1,4 +1,4 @@
-/* vms.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 2001 by Marc Milgram <ethereal@mmilgram.NOSPAMmail.net>
--- a/wiretap/vwr.h
+++ b/wiretap/vwr.h
@ -1,4 +1,4 @@
-/* vwr.h
+/** @file
 *
 * Wiretap Library
 * Copyright (c) 1998-2010 by Tom Alexander <talexander@ixiacom.com>
--- a/wiretap/wtap_modules.h
+++ b/wiretap/wtap_modules.h
@ -1,4 +1,5 @@
-/* wtap_modules.h
+/** @file
+ *
 * Definitions for wiretap module registration
 *
 * Wireshark - Network traffic analyzer