wiretap: Add header files to Doxygen

Add @file markers for wiretap
headers so that Doxygen will
generate documentation for them.
This commit is contained in:
Moshe Kaplan 2021-11-29 21:59:23 -05:00
parent 504de90a3c
commit 34454a5037
74 changed files with 80 additions and 74 deletions

View File

@ -1,4 +1,4 @@
/* 5views.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* aethra.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,5 @@
/* ascend-int.h /** @file
*
* Definitions for routines common to multiple modules in the Lucent/Ascend * Definitions for routines common to multiple modules in the Lucent/Ascend
* capture file reading code code, but not used outside that code. * capture file reading code code, but not used outside that code.
* *

View File

@ -1,4 +1,4 @@
/* ascend.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* atm.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* ber.h /** @file
* *
* Basic Encoding Rules (BER) file reading * Basic Encoding Rules (BER) file reading
* *

View File

@ -1,4 +1,4 @@
/* blf.h /** @file
* *
* BLF file format decoder for the Wiretap library. * BLF file format decoder for the Wiretap library.
* *

View File

@ -1,4 +1,4 @@
/* btsnoop.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* busmaster.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* busmaster_priv.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* camins.h /** @file
* *
* File format support for Rabbit Labs CAM Inspector files * File format support for Rabbit Labs CAM Inspector files
* Copyright (c) 2013 by Martin Kaiser <martin@kaiser.cx> * Copyright (c) 2013 by Martin Kaiser <martin@kaiser.cx>

View File

@ -1,4 +1,4 @@
/* candump.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* candump-priv.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* capsa.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* catapult_dct2000.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

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

View File

@ -1,4 +1,4 @@
/* cosine.h /** @file
* *
* CoSine IPNOS L2 debug output parsing * CoSine IPNOS L2 debug output parsing
* Copyright (c) 2002 by Motonori Shindo <motonori@shin.do> * Copyright (c) 2002 by Motonori Shindo <motonori@shin.do>

View File

@ -1,4 +1,4 @@
/* csids.h /** @file
* *
* Copyright (c) 2000 by Mike Hall <mlh@io.com> * Copyright (c) 2000 by Mike Hall <mlh@io.com>
* Copyright (c) Cisco Systems * Copyright (c) Cisco Systems

View File

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

View File

@ -1,4 +1,4 @@
/* dbs-etherwatch.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* dct3trace.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* dpa400.h /** @file
* *
* Copyright 2018, Dirk Eibach, Guntermann & Drunck GmbH <dirk.eibach@gdsys.cc> * Copyright 2018, Dirk Eibach, Guntermann & Drunck GmbH <dirk.eibach@gdsys.cc>
* *

View File

@ -1,4 +1,4 @@
/* /** @file
* *
* Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand. * Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
* All rights reserved. * All rights reserved.

View File

@ -1,4 +1,4 @@
/* /** @file
* *
* Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand. * Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
* All rights reserved. * All rights reserved.

View File

@ -1,4 +1,4 @@
/* /** @file
* *
* Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand. * Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
* All rights reserved. * All rights reserved.

View File

@ -1,4 +1,4 @@
/* eri_enb_log.h /** @file
* *
* Ericsson eNode-B raw log file format decoder for the Wiretap library. * Ericsson eNode-B raw log file format decoder for the Wiretap library.
* *

View File

@ -1,4 +1,4 @@
/* eyesdn.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* hcidump.h /** @file
* *
* Copyright (c) 2003 by Marcel Holtmann <marcel@holtmann.org> * Copyright (c) 2003 by Marcel Holtmann <marcel@holtmann.org>
* *

View File

@ -1,4 +1,5 @@
/* /** @file
*
* Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved. * Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
* *
* SPDX-License-Identifier: BSD-2-Clause * SPDX-License-Identifier: BSD-2-Clause

View File

@ -1,4 +1,4 @@
/* i4btrace.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1999 by Bert Driehuis <driehuis@playbeing.org> * Copyright (c) 1999 by Bert Driehuis <driehuis@playbeing.org>

View File

@ -1,4 +1,4 @@
/* ipfix.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 2010 by Hadriel Kaplan <hadrielk@yahoo.com> * Copyright (c) 2010 by Hadriel Kaplan <hadrielk@yahoo.com>

View File

@ -1,4 +1,4 @@
/* iptrace.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* iseries.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 2005 by Martin Warnes <martin@warnes.homeip.net> * Copyright (c) 2005 by Martin Warnes <martin@warnes.homeip.net>

View File

@ -1,4 +1,4 @@
/* json.h /** @file
* *
* Copyright 2015, Dario Lombardo <lomato@gmail.com> * Copyright 2015, Dario Lombardo <lomato@gmail.com>
* *

View File

@ -1,4 +1,4 @@
/* k12.c /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* lanalyzer.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* libpcap.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* log_3gpp.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* logcat.h /** @file
* *
* Copyright 2014, Michal Labedzki for Tieto Corporation * Copyright 2014, Michal Labedzki for Tieto Corporation
* *

View File

@ -1,4 +1,4 @@
/* logcat_text.h /** @file
* *
* Copyright 2014, Michal Orynicz for Tieto Corporation * Copyright 2014, Michal Orynicz for Tieto Corporation
* *

View File

@ -1,4 +1,4 @@
/* mime_file.h /** @file
* *
* MIME file format decoder for the Wiretap library. * MIME file format decoder for the Wiretap library.
* *

View File

@ -1,4 +1,4 @@
/* mp2t.h /** @file
* *
* ISO/IEC 13818-1 MPEG2-TS file format decoder for the Wiretap library. * ISO/IEC 13818-1 MPEG2-TS file format decoder for the Wiretap library.
* Written by Weston Schmidt <weston_schmidt@alumni.purdue.edu> * Written by Weston Schmidt <weston_schmidt@alumni.purdue.edu>

View File

@ -1,4 +1,4 @@
/* mp4.h /** @file
* *
* MP4 (ISO/IEC 14496-12) file format decoder for the Wiretap library. * MP4 (ISO/IEC 14496-12) file format decoder for the Wiretap library.
* *

View File

@ -1,4 +1,4 @@
/* mpeg.h /** @file
* *
* MPEG file format decoder for the Wiretap library. * MPEG file format decoder for the Wiretap library.
* Written by Shaun Jackman <sjackman@gmail.com> * Written by Shaun Jackman <sjackman@gmail.com>

View File

@ -1,4 +1,4 @@
/* mplog.h /** @file
* *
* File format support for Micropross mplog files * File format support for Micropross mplog files
* Copyright (c) 2016 by Martin Kaiser <martin@kaiser.cx> * Copyright (c) 2016 by Martin Kaiser <martin@kaiser.cx>

View File

@ -1,4 +1,4 @@
/* netmon.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* netscaler.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 2006 by Ravi Kondamuru <Ravi.Kondamuru@citrix.com> * Copyright (c) 2006 by Ravi Kondamuru <Ravi.Kondamuru@citrix.com>

View File

@ -1,4 +1,4 @@
/* netscreen.h /** @file
* *
* Juniper NetScreen snoop output parser * Juniper NetScreen snoop output parser
* Created by re-using a lot of code from cosine.c * Created by re-using a lot of code from cosine.c

View File

@ -1,4 +1,4 @@
/* nettl.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* nettrace_3gpp_32_423.h /** @file
* *
* MIME file format decoder for the Wiretap library. * MIME file format decoder for the Wiretap library.
* *

View File

@ -1,4 +1,4 @@
/* netxray.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* ngsniffer.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/*************************************************************************** /** @file
observer.h - description observer.h - description
------------------- -------------------
begin : Wed Oct 29 2003 begin : Wed Oct 29 2003

View File

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

View File

@ -1,4 +1,5 @@
/* pcap-common.h /** @file
*
* Declarations for code common to pcap and pcapng file formats * Declarations for code common to pcap and pcapng file formats
* *
* Wiretap Library * Wiretap Library

View File

@ -1,4 +1,4 @@
/* pcapng.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* peekclassic.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* peektagged.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* pppdump.h /** @file
* *
* Copyright (c) 2000 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 2000 by Gilbert Ramirez <gram@alumni.rice.edu>
* *

View File

@ -1,4 +1,4 @@
/* radcom.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,5 @@
/* required_file_handlers.h /** @file
*
* Functions and variables defined by required file handlers (pcap, * Functions and variables defined by required file handlers (pcap,
* nanosecond pcap, pcapng). * nanosecond pcap, pcapng).
* *

View File

@ -1,4 +1,4 @@
/* rfc7468.h /** @file
* *
* SPDX-License-Identifier: GPL-2.0-or-later * SPDX-License-Identifier: GPL-2.0-or-later
*/ */

View File

@ -1,4 +1,4 @@
/* ruby_marshal.h /** @file
* *
* Copyright 2018, Dario Lombardo <lomato@gmail.com> * Copyright 2018, Dario Lombardo <lomato@gmail.com>
* *

View File

@ -1,4 +1,5 @@
/* secrets-types.h /** @file
*
* Identifiers used by Decryption Secrets Blocks (DSB). * Identifiers used by Decryption Secrets Blocks (DSB).
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,4 +1,4 @@
/* snoop.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* socketcan.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* stanag4607.h /** @file
* *
* STANAG 4607 file reading * STANAG 4607 file reading
* *

View File

@ -1,4 +1,4 @@
/* systemd_journal.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* tnef.h /** @file
* *
* Transport-Neutral Encapsulation Format (TNEF) file reading * Transport-Neutral Encapsulation Format (TNEF) file reading
* *

View File

@ -1,4 +1,4 @@
/* toshiba.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu> * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

View File

@ -1,4 +1,4 @@
/* visual.h /** @file
* *
* File read write routines for Visual Networks .cap files. * File read write routines for Visual Networks .cap files.
* Copyright 2001, Tom Nisbet tnisbet@visualnetworks.com * Copyright 2001, Tom Nisbet tnisbet@visualnetworks.com

View File

@ -1,4 +1,4 @@
/* vms.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 2001 by Marc Milgram <ethereal@mmilgram.NOSPAMmail.net> * Copyright (c) 2001 by Marc Milgram <ethereal@mmilgram.NOSPAMmail.net>

View File

@ -1,4 +1,4 @@
/* vwr.h /** @file
* *
* Wiretap Library * Wiretap Library
* Copyright (c) 1998-2010 by Tom Alexander <talexander@ixiacom.com> * Copyright (c) 1998-2010 by Tom Alexander <talexander@ixiacom.com>

View File

@ -1,4 +1,5 @@
/* wtap_modules.h /** @file
*
* Definitions for wiretap module registration * Definitions for wiretap module registration
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer