From 7567432ec46b75434fbc5364437b44e0d61e6a43 Mon Sep 17 00:00:00 2001
From: Moshe Kaplan <me@moshekaplan.com>
Date: Mon, 29 Nov 2021 23:27:19 -0500
Subject: [PATCH] Add remaining header files to Doxygen

Add @file markers for remaining
header files so that Doxygen will
generate documentation for them.
---
 cfile.h                     | 3 ++-
 cli_main.h                  | 3 ++-
 file.h                      | 3 ++-
 fileset.h                   | 3 ++-
 frame_tvbuff.h              | 3 ++-
 fuzz/FuzzerInterface.h      | 1 +
 globals.h                   | 3 ++-
 randpkt_core/randpkt_core.h | 3 ++-
 ringbuffer.h                | 3 ++-
 sharkd.h                    | 2 +-
 speexdsp/speex_resampler.h  | 4 +++-
 text2pcap.h                 | 4 +---
 tools/lemon/cppmagic.h      | 2 +-
 tools/npl/ast.h             | 3 ++-
 writecap/pcapio.h           | 3 ++-
 wspcap.h                    | 2 +-
 16 files changed, 28 insertions(+), 17 deletions(-)

diff --git a/cfile.h b/cfile.h
index 08307ac3db..e532ecc286 100644
--- a/cfile.h
+++ b/cfile.h
@@ -1,4 +1,5 @@
-/* cfile.h
+/** @file
+ *
  * capture_file definition & GUI-independent manipulation
  *
  * Wireshark - Network traffic analyzer
diff --git a/cli_main.h b/cli_main.h
index e515485529..d05b9f2881 100644
--- a/cli_main.h
+++ b/cli_main.h
@@ -1,4 +1,5 @@
-/*
+/** @file
+ *
  * Declaration of the real main routine, for all CLI programs where the
  * 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
diff --git a/file.h b/file.h
index fb968d8aca..8b3bdf584b 100644
--- a/file.h
+++ b/file.h
@@ -1,4 +1,5 @@
-/* file.h
+/** @file
+ *
  * Definitions for file structures and routines
  *
  * Wireshark - Network traffic analyzer
diff --git a/fileset.h b/fileset.h
index 49245790c1..9155b43fb2 100644
--- a/fileset.h
+++ b/fileset.h
@@ -1,4 +1,5 @@
-/* fileset.h
+/** @file
+ *
  * Definitions for routines for file sets.
  *
  * Wireshark - Network traffic analyzer
diff --git a/frame_tvbuff.h b/frame_tvbuff.h
index 05f48c2e8b..612c100e4f 100644
--- a/frame_tvbuff.h
+++ b/frame_tvbuff.h
@@ -1,4 +1,5 @@
-/* frame_tvbuff.h
+/** @file
+ *
  * Implements a tvbuff for frame
  *
  * Wireshark - Network traffic analyzer
diff --git a/fuzz/FuzzerInterface.h b/fuzz/FuzzerInterface.h
index 2208675e33..233110e66d 100644
--- a/fuzz/FuzzerInterface.h
+++ b/fuzz/FuzzerInterface.h
@@ -1,3 +1,4 @@
+/** @file */
 /* 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 */
diff --git a/globals.h b/globals.h
index b4270fcb55..0fd3ba6ebd 100644
--- a/globals.h
+++ b/globals.h
@@ -1,4 +1,5 @@
-/* globals.h
+/** @file
+ *
  * Global defines, etc.
  *
  * Wireshark - Network traffic analyzer
diff --git a/randpkt_core/randpkt_core.h b/randpkt_core/randpkt_core.h
index b6bb83c66e..0e54ac8503 100644
--- a/randpkt_core/randpkt_core.h
+++ b/randpkt_core/randpkt_core.h
@@ -1,4 +1,5 @@
-/*
+/** @file
+ *
  * randpkt_core.h
  * ---------
  * Creates random packet traces. Useful for debugging sniffers by testing
diff --git a/ringbuffer.h b/ringbuffer.h
index 2118029b44..07df4c2587 100644
--- a/ringbuffer.h
+++ b/ringbuffer.h
@@ -1,4 +1,5 @@
-/* ringbuffer.h
+/** @file
+ *
  * Definitions for capture ringbuffer files
  *
  * Wireshark - Network traffic analyzer
diff --git a/sharkd.h b/sharkd.h
index edbf69d9f7..4bd3f6ddb5 100644
--- a/sharkd.h
+++ b/sharkd.h
@@ -1,4 +1,4 @@
-/* sharkd.h
+/** @file
  *
  * Copyright (C) 2016 Jakub Zawadzki
  *
diff --git a/speexdsp/speex_resampler.h b/speexdsp/speex_resampler.h
index 75e7658086..284e7ec8ed 100644
--- a/speexdsp/speex_resampler.h
+++ b/speexdsp/speex_resampler.h
@@ -1,4 +1,6 @@
-/* Copyright (C) 2007 Jean-Marc Valin
+/** @file
+
+   Copyright (C) 2007 Jean-Marc Valin
 
    File: speex_resampler.h
    Resampling code
diff --git a/text2pcap.h b/text2pcap.h
index 09a66584e0..955100a3c3 100644
--- a/text2pcap.h
+++ b/text2pcap.h
@@ -1,6 +1,4 @@
-/**-*-C-*-**********************************************************************
- *
- * text2pcap.h
+/** @file
  *
  * Utility to convert an ASCII hexdump into a libpcap-format capture file
  *
diff --git a/tools/lemon/cppmagic.h b/tools/lemon/cppmagic.h
index ea45018567..74599ef093 100644
--- a/tools/lemon/cppmagic.h
+++ b/tools/lemon/cppmagic.h
@@ -1,4 +1,4 @@
-
+/** @file */
 /**************************************** CPP definitions ***************/
 
 /* CPP magic: Concatenate two strings or macros that resolve to strings.
diff --git a/tools/npl/ast.h b/tools/npl/ast.h
index ac4b5ae931..67ce4e31d7 100644
--- a/tools/npl/ast.h
+++ b/tools/npl/ast.h
@@ -1,4 +1,5 @@
-/*
+/** @file
+ *
  * Copyright 2012-2013, Jakub Zawadzki <darkjames-ws@darkjames.pl>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
diff --git a/writecap/pcapio.h b/writecap/pcapio.h
index 72df645a76..2d81591e14 100644
--- a/writecap/pcapio.h
+++ b/writecap/pcapio.h
@@ -1,4 +1,5 @@
-/* pcapio.h
+/** @file
+ *
  * Declarations of our own routines for writing libpcap files.
  *
  * Wireshark - Network traffic analyzer
diff --git a/wspcap.h b/wspcap.h
index 54d34633cb..0ccb8d4818 100644
--- a/wspcap.h
+++ b/wspcap.h
@@ -1,4 +1,4 @@
-/* wspcap.h
+/** @file
  *
  * Wrapper around libpcap/WinPcap's pcap.h.
  *