Add remaining header files to Doxygen

Add @file markers for remaining
header files so that Doxygen will
generate documentation for them.
This commit is contained in:
Moshe Kaplan 2021-11-29 23:27:19 -05:00
parent b62197c283
commit 7567432ec4
16 changed files with 28 additions and 17 deletions

View File

@ -1,4 +1,5 @@
/* cfile.h /** @file
*
* capture_file definition & GUI-independent manipulation * capture_file definition & GUI-independent manipulation
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,4 +1,5 @@
/* /** @file
*
* Declaration of the real main routine, for all CLI programs where the * Declaration of the real main routine, for all CLI programs where the
* main routine should get UTF-8 arguments on Windows. In those programs, * main routine should get UTF-8 arguments on Windows. In those programs,
* in the file that defines the main routine, include this header and link * in the file that defines the main routine, include this header and link

3
file.h
View File

@ -1,4 +1,5 @@
/* file.h /** @file
*
* Definitions for file structures and routines * Definitions for file structures and routines
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,4 +1,5 @@
/* fileset.h /** @file
*
* Definitions for routines for file sets. * Definitions for routines for file sets.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,4 +1,5 @@
/* frame_tvbuff.h /** @file
*
* Implements a tvbuff for frame * Implements a tvbuff for frame
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,3 +1,4 @@
/** @file */
/* based on http://llvm.org/svn/llvm-project/compiler-rt/trunk/lib/fuzzer/FuzzerInterface.h r321218 (20 Dec 2017) */ /* based on http://llvm.org/svn/llvm-project/compiler-rt/trunk/lib/fuzzer/FuzzerInterface.h r321218 (20 Dec 2017) */
/* http://llvm.org/svn/llvm-project/compiler-rt/trunk/LICENSE.TXT follows */ /* http://llvm.org/svn/llvm-project/compiler-rt/trunk/LICENSE.TXT follows */

View File

@ -1,4 +1,5 @@
/* globals.h /** @file
*
* Global defines, etc. * Global defines, etc.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,4 +1,5 @@
/* /** @file
*
* randpkt_core.h * randpkt_core.h
* --------- * ---------
* Creates random packet traces. Useful for debugging sniffers by testing * Creates random packet traces. Useful for debugging sniffers by testing

View File

@ -1,4 +1,5 @@
/* ringbuffer.h /** @file
*
* Definitions for capture ringbuffer files * Definitions for capture ringbuffer files
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,4 +1,4 @@
/* sharkd.h /** @file
* *
* Copyright (C) 2016 Jakub Zawadzki * Copyright (C) 2016 Jakub Zawadzki
* *

View File

@ -1,4 +1,6 @@
/* Copyright (C) 2007 Jean-Marc Valin /** @file
Copyright (C) 2007 Jean-Marc Valin
File: speex_resampler.h File: speex_resampler.h
Resampling code Resampling code

View File

@ -1,6 +1,4 @@
/**-*-C-*-********************************************************************** /** @file
*
* text2pcap.h
* *
* Utility to convert an ASCII hexdump into a libpcap-format capture file * Utility to convert an ASCII hexdump into a libpcap-format capture file
* *

View File

@ -1,4 +1,4 @@
/** @file */
/**************************************** CPP definitions ***************/ /**************************************** CPP definitions ***************/
/* CPP magic: Concatenate two strings or macros that resolve to strings. /* CPP magic: Concatenate two strings or macros that resolve to strings.

View File

@ -1,4 +1,5 @@
/* /** @file
*
* Copyright 2012-2013, Jakub Zawadzki <darkjames-ws@darkjames.pl> * Copyright 2012-2013, Jakub Zawadzki <darkjames-ws@darkjames.pl>
* *
* SPDX-License-Identifier: GPL-2.0-or-later * SPDX-License-Identifier: GPL-2.0-or-later

View File

@ -1,4 +1,5 @@
/* pcapio.h /** @file
*
* Declarations of our own routines for writing libpcap files. * Declarations of our own routines for writing libpcap files.
* *
* Wireshark - Network traffic analyzer * Wireshark - Network traffic analyzer

View File

@ -1,4 +1,4 @@
/* wspcap.h /** @file
* *
* Wrapper around libpcap/WinPcap's pcap.h. * Wrapper around libpcap/WinPcap's pcap.h.
* *