Add files with WS_DLL_PUBLIC to Doxygen

Add @file markers for most files that
contain functions exported with
WS_DLL_PUBLIC so that Doxygen will
generate documentation for them.

59 files changed, 63 insertions, 65 deletions

diff --git a/wsutil/adler32.h b/wsutil/adler32.h
index e5b72b8110..2c56d8e83d 100644
--- a/wsutil/adler32.h
+++ b/wsutil/adler32.h
@@ -1,4 +1,4 @@
-/* adler32.h
+/** @file
  * Compute the Adler32 checksum (RFC 1950)
  * 2003 Tomas Kukosa
  *
diff --git a/wsutil/base32.h b/wsutil/base32.h
index 75251e66b9..b1f1732bb8 100644
--- a/wsutil/base32.h
+++ b/wsutil/base32.h
@@ -1,4 +1,4 @@
-/* base32.h
+/** @file
  * Base-32 conversion
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/bitswap.h b/wsutil/bitswap.h
index 8f4a05d9a0..26a2c64f88 100644
--- a/wsutil/bitswap.h
+++ b/wsutil/bitswap.h
@@ -1,4 +1,4 @@
-/* bitswap.h
+/** @file
  * Macro to bitswap a byte by looking it up in a table
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/buffer.h b/wsutil/buffer.h
index 5ca90b1bd0..9f98f58418 100644
--- a/wsutil/buffer.h
+++ b/wsutil/buffer.h
@@ -1,4 +1,4 @@
-/* buffer.h
+/** @file
  *
  * Wiretap Library
  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
diff --git a/wsutil/cfutils.h b/wsutil/cfutils.h
index c6ed5a2486..12cbefef4c 100644
--- a/wsutil/cfutils.h
+++ b/wsutil/cfutils.h
@@ -1,4 +1,4 @@
-/* cfutils.h
+/** @file
  * Declarations of routines to work around deficiencies in Core Foundation,
  * such as the lack of a routine to convert a CFString to a C string of
  * arbitrary size.
diff --git a/wsutil/codecs.h b/wsutil/codecs.h
index 47f8ff1451..ea3ae88754 100644
--- a/wsutil/codecs.h
+++ b/wsutil/codecs.h
@@ -1,4 +1,4 @@
-/* codecs.h
+/** @file
  * codecs interface   2007 Tomas Kukosa
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/copyright_info.h b/wsutil/copyright_info.h
index 83abcd6273..503355f5d5 100644
--- a/wsutil/copyright_info.h
+++ b/wsutil/copyright_info.h
@@ -1,4 +1,4 @@
-/* copyright_info.h
+/** @file
  * Declarations of outines to report copyright information for stuff used
  * by Wireshark
  *
diff --git a/wsutil/cpu_info.h b/wsutil/cpu_info.h
index 145b1bef00..bd39974b9e 100644
--- a/wsutil/cpu_info.h
+++ b/wsutil/cpu_info.h
@@ -1,4 +1,4 @@
-/* cpu_info.h
+/** @file
  * Declarations of routines to report CPU information
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/crash_info.h b/wsutil/crash_info.h
index ec50df345b..ce9e70f070 100644
--- a/wsutil/crash_info.h
+++ b/wsutil/crash_info.h
@@ -1,4 +1,4 @@
-/* crash_info.h
+/** @file
  * Routines to try to provide more useful information in crash dumps.
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/crc10.h b/wsutil/crc10.h
index 2834cd3bbf..c1fb16014f 100644
--- a/wsutil/crc10.h
+++ b/wsutil/crc10.h
@@ -1,5 +1,4 @@
-/*
- *  crc10.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
diff --git a/wsutil/crc11.h b/wsutil/crc11.h
index c9ac52ba18..52e018080c 100644
--- a/wsutil/crc11.h
+++ b/wsutil/crc11.h
@@ -1,5 +1,4 @@
-/*
- * crc11.h
+/** @file
  * http://www.tty1.net/pycrc/faq_en.html#code-ownership
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/crc16-plain.h b/wsutil/crc16-plain.h
index f2efe1a0d3..3e95eaefc6 100644
--- a/wsutil/crc16-plain.h
+++ b/wsutil/crc16-plain.h
@@ -1,5 +1,4 @@
-/*
- * crc16-plain.h
+/** @file
  * http://www.tty1.net/pycrc/faq_en.html#code-ownership
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/crc16.h b/wsutil/crc16.h
index 64b6203f13..0bd0de64fb 100644
--- a/wsutil/crc16.h
+++ b/wsutil/crc16.h
@@ -1,4 +1,4 @@
-/* crc16.h
+/** @file
  * Declaration of CRC-16 routines and table
  *
  * 2004 Richard van der Hoff <richardv@mxtelecom.com>
diff --git a/wsutil/crc32.h b/wsutil/crc32.h
index 09f293277f..9f07045db5 100644
--- a/wsutil/crc32.h
+++ b/wsutil/crc32.h
@@ -1,4 +1,4 @@
-/* crc32.h
+/** @file
  * Declaration of CRC-32 routine and table
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/crc5.h b/wsutil/crc5.h
index da3fde41fd..1201112048 100644
--- a/wsutil/crc5.h
+++ b/wsutil/crc5.h
@@ -1,4 +1,4 @@
-/* crc5.h
+/** @file
  * Declaration of CRC-5 routines and table
  *
  * 2019 Tomasz Mon <desowin@gmail.com>
diff --git a/wsutil/crc6.h b/wsutil/crc6.h
index f9c187f2a8..e177ed01e9 100644
--- a/wsutil/crc6.h
+++ b/wsutil/crc6.h
@@ -1,5 +1,4 @@
-/*
- *  crc6.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
diff --git a/wsutil/crc7.h b/wsutil/crc7.h
index adb35aac0f..fd5857737f 100644
--- a/wsutil/crc7.h
+++ b/wsutil/crc7.h
@@ -1,5 +1,4 @@
-/*
- * crc7.h
+/** @file
  *
  * Functions and types for CRC checks.
  *
diff --git a/wsutil/crc8.h b/wsutil/crc8.h
index 269fbc2ea4..1b5a7721e2 100644
--- a/wsutil/crc8.h
+++ b/wsutil/crc8.h
@@ -1,4 +1,4 @@
-/* crc8.h
+/** @file
  * Declaration of CRC-8 routine and tables
  *
  * 2011 Roland Knall <rknall@gmail.com>
diff --git a/wsutil/curve25519.h b/wsutil/curve25519.h
index fc6a28450a..387ee29f5d 100644
--- a/wsutil/curve25519.h
+++ b/wsutil/curve25519.h
@@ -1,4 +1,4 @@
-/* curve25519.h
+/** @file
  * NaCl/Sodium-compatible API for Curve25519 cryptography.
  *
  * Copyright (c) 2018, Peter Wu <peter@lekensteyn.nl>
diff --git a/wsutil/eax.h b/wsutil/eax.h
index bc7118c290..252b81208d 100644
--- a/wsutil/eax.h
+++ b/wsutil/eax.h
@@ -1,4 +1,4 @@
-/* eax.h
+/** @file
  * Encryption and decryption routines implementing the EAX' encryption mode
  * Copyright 2010, Edward J. Beroset, edward.j.beroset@us.elster.com
  *
diff --git a/wsutil/file_util.h b/wsutil/file_util.h
index f68dc53615..12ad3a1693 100644
--- a/wsutil/file_util.h
+++ b/wsutil/file_util.h
@@ -1,4 +1,4 @@
-/* file_util.h
+/** @file
  * File utility definitions
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/filesystem.h b/wsutil/filesystem.h
index d648e197e9..2a7f95647d 100644
--- a/wsutil/filesystem.h
+++ b/wsutil/filesystem.h
@@ -1,4 +1,4 @@
-/* filesystem.h
+/** @file
  * Filesystem utility definitions
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/g711.h b/wsutil/g711.h
index 81e66bede1..d5196da89e 100644
--- a/wsutil/g711.h
+++ b/wsutil/g711.h
@@ -1,5 +1,4 @@
-/*
- * g711.h
+/** @file
  *
  * Definitions for routines for u-law, A-law and linear PCM conversions
  *
diff --git a/wsutil/inet_addr.h b/wsutil/inet_addr.h
index 378cf49b4e..5bc4e7ea9f 100644
--- a/wsutil/inet_addr.h
+++ b/wsutil/inet_addr.h
@@ -1,4 +1,4 @@
-/* inet_addr.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
diff --git a/wsutil/interface.h b/wsutil/interface.h
index ee9ab1c0a0..5c431bfa0e 100644
--- a/wsutil/interface.h
+++ b/wsutil/interface.h
@@ -1,4 +1,4 @@
-/* interface.c
+/** @file
  * Utility functions to get infos from interfaces
  *
  * Copyright 2016, Dario Lombardo
diff --git a/wsutil/json_dumper.h b/wsutil/json_dumper.h
index 3ed7563e2a..bc382c3524 100644
--- a/wsutil/json_dumper.h
+++ b/wsutil/json_dumper.h
@@ -1,4 +1,4 @@
-/* wsjson.h
+/** @file
  * Routines for serializing data as JSON.
  *
  * Copyright 2018, Peter Wu <peter@lekensteyn.nl>
diff --git a/wsutil/mpeg-audio.h b/wsutil/mpeg-audio.h
index ce102117e4..ced51ff745 100644
--- a/wsutil/mpeg-audio.h
+++ b/wsutil/mpeg-audio.h
@@ -1,4 +1,4 @@
-/* mpeg-audio.h
+/** @file
  *
  * MPEG Audio header dissection
  * Written by Shaun Jackman <sjackman@gmail.com>
diff --git a/wsutil/os_version_info.h b/wsutil/os_version_info.h
index a56c132e4f..825e801873 100644
--- a/wsutil/os_version_info.h
+++ b/wsutil/os_version_info.h
@@ -1,4 +1,4 @@
-/* os_version_info.h
+/** @file
  * Declarations of outines to report operating system version information
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/please_report_bug.h b/wsutil/please_report_bug.h
index 508bf5a1a5..e99b26ca2a 100644
--- a/wsutil/please_report_bug.h
+++ b/wsutil/please_report_bug.h
@@ -1,4 +1,4 @@
-/* please_report_bug.h
+/** @file
  * Declarations of routines returning strings to use when reporting a bug.
  * They ask the user to report a bug to the Wireshark developers.
  *
diff --git a/wsutil/plugins.h b/wsutil/plugins.h
index a971e869f8..2cf2c4e80d 100644
--- a/wsutil/plugins.h
+++ b/wsutil/plugins.h
@@ -1,4 +1,4 @@
-/* plugins.h
+/** @file
  * definitions for plugins structures
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/privileges.h b/wsutil/privileges.h
index 3a6169e434..4c712bbf32 100644
--- a/wsutil/privileges.h
+++ b/wsutil/privileges.h
@@ -1,4 +1,4 @@
-/* privileges.h
+/** @file
  * Declarations of routines for handling privileges.
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/report_message.h b/wsutil/report_message.h
index 76078d3879..a282a8be00 100644
--- a/wsutil/report_message.h
+++ b/wsutil/report_message.h
@@ -1,4 +1,4 @@
-/* report_message.h
+/** @file
  * Declarations of routines for code that can run in GUI and command-line
  * environments to use to report errors and warnings to the user (e.g.,
  * I/O errors, or problems with preference settings) if the message should
diff --git a/wsutil/rsa.h b/wsutil/rsa.h
index 07ddf8547a..8d51c4b2ba 100644
--- a/wsutil/rsa.h
+++ b/wsutil/rsa.h
@@ -1,4 +1,4 @@
-/* rsa.h
+/** @file
  *
  * Functions for RSA private key reading and use
  *
diff --git a/wsutil/socket.h b/wsutil/socket.h
index 8d89b24267..8387ecf2f4 100644
--- a/wsutil/socket.h
+++ b/wsutil/socket.h
@@ -1,4 +1,4 @@
-/* socket.h
+/** @file
  * Socket wrappers
  *
  * Copyright 2016, Dario Lombardo
diff --git a/wsutil/str_util.h b/wsutil/str_util.h
index 07e929dff7..8a2eaabce8 100644
--- a/wsutil/str_util.h
+++ b/wsutil/str_util.h
@@ -1,4 +1,4 @@
-/* str_util.h
+/** @file
  * String utility definitions
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/strnatcmp.h b/wsutil/strnatcmp.h
index 8f6b7828ef..0ebe1f6f4f 100644
--- a/wsutil/strnatcmp.h
+++ b/wsutil/strnatcmp.h
@@ -1,4 +1,4 @@
-/* strnatcmp.h
+/** @file
  *
  * Original code downloaded from: http://sourcefrog.net/projects/natsort/
 
diff --git a/wsutil/strptime.h b/wsutil/strptime.h
index af5baabbc6..43671a4af3 100644
--- a/wsutil/strptime.h
+++ b/wsutil/strptime.h
@@ -1,4 +1,4 @@
-/* strptime.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
diff --git a/wsutil/strtoi.h b/wsutil/strtoi.h
index 6e2fabed07..516eeb5519 100644
--- a/wsutil/strtoi.h
+++ b/wsutil/strtoi.h
@@ -1,4 +1,4 @@
-/* strtoi.h
+/** @file
  * Utilities to convert strings to integers
  *
  * Copyright 2016, Dario Lombardo
diff --git a/wsutil/time_util.h b/wsutil/time_util.h
index 40914d29a5..ef15c5e5d8 100644
--- a/wsutil/time_util.h
+++ b/wsutil/time_util.h
@@ -1,4 +1,4 @@
-/* time_util.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
diff --git a/wsutil/type_util.h b/wsutil/type_util.h
index 0944a494e1..021c6b946d 100644
--- a/wsutil/type_util.h
+++ b/wsutil/type_util.h
@@ -1,4 +1,4 @@
-/* type_util.h
+/** @file
  * Types utility definitions
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/wmem/wmem_array.h b/wsutil/wmem/wmem_array.h
index 8f57fa4c2f..0e82e66e74 100644
--- a/wsutil/wmem/wmem_array.h
+++ b/wsutil/wmem/wmem_array.h
@@ -1,4 +1,4 @@
-/* wmem_array.h
+/** @file
  * Definitions for the Wireshark Memory Manager Array
  * Copyright 2013, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_core.h b/wsutil/wmem/wmem_core.h
index 479cbee4ac..2b0f09a82b 100644
--- a/wsutil/wmem/wmem_core.h
+++ b/wsutil/wmem/wmem_core.h
@@ -1,4 +1,4 @@
-/* wmem_core.h
+/** @file
  * Definitions for the Wireshark Memory Manager Core
  * Copyright 2012, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_interval_tree.h b/wsutil/wmem/wmem_interval_tree.h
index 5fb3172e5a..128455faf1 100644
--- a/wsutil/wmem/wmem_interval_tree.h
+++ b/wsutil/wmem/wmem_interval_tree.h
@@ -1,4 +1,4 @@
-/* wmem_interval_tree.h
+/** @file
  * Definitions for the Wireshark Memory Manager Red-Black Tree
  * Based on the red-black tree implementation in epan/emem.*
  * Copyright 2015, Matthieu coudron <matthieu.coudron@lip6.fr>
diff --git a/wsutil/wmem/wmem_list.h b/wsutil/wmem/wmem_list.h
index db17df0ba7..edfc018417 100644
--- a/wsutil/wmem/wmem_list.h
+++ b/wsutil/wmem/wmem_list.h
@@ -1,4 +1,4 @@
-/* wmem_list.h
+/** @file
  * Definitions for the Wireshark Memory Manager Doubly-Linked List
  * Copyright 2012, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_map.h b/wsutil/wmem/wmem_map.h
index 86c6d529b2..b3de5061c8 100644
--- a/wsutil/wmem/wmem_map.h
+++ b/wsutil/wmem/wmem_map.h
@@ -1,4 +1,4 @@
-/* wmem_map.h
+/** @file
  * Definitions for the Wireshark Memory Manager Hash Map
  * Copyright 2014, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_miscutl.h b/wsutil/wmem/wmem_miscutl.h
index 92ce5c9be6..125f49379f 100644
--- a/wsutil/wmem/wmem_miscutl.h
+++ b/wsutil/wmem/wmem_miscutl.h
@@ -1,4 +1,4 @@
-/* wmem_miscutl.h
+/** @file
  * Definitions for the Wireshark Memory Manager Misc Utilities
  * Copyright 2013, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_stack.h b/wsutil/wmem/wmem_stack.h
index 9a30de511e..b4fd2d5676 100644
--- a/wsutil/wmem/wmem_stack.h
+++ b/wsutil/wmem/wmem_stack.h
@@ -1,4 +1,4 @@
-/* wmem_stack.h
+/** @file
  * Definitions for the Wireshark Memory Manager Stack
  * Copyright 2012, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_strbuf.h b/wsutil/wmem/wmem_strbuf.h
index 95559499f9..55f2b77292 100644
--- a/wsutil/wmem/wmem_strbuf.h
+++ b/wsutil/wmem/wmem_strbuf.h
@@ -1,4 +1,4 @@
-/* wmem_strbuf.h
+/** @file
  * Definitions for the Wireshark Memory Manager String Buffer
  * Copyright 2012, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_strutl.h b/wsutil/wmem/wmem_strutl.h
index 87963a77b3..531867ac86 100644
--- a/wsutil/wmem/wmem_strutl.h
+++ b/wsutil/wmem/wmem_strutl.h
@@ -1,4 +1,4 @@
-/* wmem_strutl.h
+/** @file
  * Definitions for the Wireshark Memory Manager String Utilities
  * Copyright 2012, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/wmem/wmem_tree.h b/wsutil/wmem/wmem_tree.h
index 51f3c9908b..c12d45c37e 100644
--- a/wsutil/wmem/wmem_tree.h
+++ b/wsutil/wmem/wmem_tree.h
@@ -1,4 +1,4 @@
-/* wmem_tree.h
+/** @file
  * Definitions for the Wireshark Memory Manager Red-Black Tree
  * Based on the red-black tree implementation in epan/emem.*
  * Copyright 2013, Evan Huus <eapache@gmail.com>
diff --git a/wsutil/wmem/wmem_user_cb.h b/wsutil/wmem/wmem_user_cb.h
index e107dcdaa9..236f55ebb1 100644
--- a/wsutil/wmem/wmem_user_cb.h
+++ b/wsutil/wmem/wmem_user_cb.h
@@ -1,4 +1,4 @@
-/* wmem_user_cb.h
+/** @file
  * Definitions for the Wireshark Memory Manager User Callbacks
  * Copyright 2012, Evan Huus <eapache@gmail.com>
  *
diff --git a/wsutil/ws_assert.h b/wsutil/ws_assert.h
index 90e4647279..9ba1d2ec37 100644
--- a/wsutil/ws_assert.h
+++ b/wsutil/ws_assert.h
@@ -1,4 +1,4 @@
-/* ws_assert.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
diff --git a/wsutil/ws_getopt.h b/wsutil/ws_getopt.h
index 3f49de4415..b32badceac 100644
--- a/wsutil/ws_getopt.h
+++ b/wsutil/ws_getopt.h
@@ -1,4 +1,5 @@
-/*
+/** @file
+ *
  * musl as a whole is licensed under the following standard MIT license:
  *
  * ----------------------------------------------------------------------
diff --git a/wsutil/ws_mempbrk.h b/wsutil/ws_mempbrk.h
index 80bceb4523..dddcc12b01 100644
--- a/wsutil/ws_mempbrk.h
+++ b/wsutil/ws_mempbrk.h
@@ -1,4 +1,4 @@
-/* ws_mempbrk.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
diff --git a/wsutil/ws_pipe.h b/wsutil/ws_pipe.h
index 35a189097e..d3f8931144 100644
--- a/wsutil/ws_pipe.h
+++ b/wsutil/ws_pipe.h
@@ -1,4 +1,4 @@
-/* ws_pipe.h
+/** @file
  *
  * Routines for handling pipes.
  *
diff --git a/wsutil/wsgcrypt.h b/wsutil/wsgcrypt.h
index 6099667780..493540d64a 100644
--- a/wsutil/wsgcrypt.h
+++ b/wsutil/wsgcrypt.h
@@ -1,4 +1,4 @@
-/* wsgcrypt.h
+/** @file
  *
  * Wrapper around libgcrypt's include file gcrypt.h.
  * For libgcrypt 1.5.0, including gcrypt.h directly brings up lots of
diff --git a/wsutil/wsjson.h b/wsutil/wsjson.h
index 1e0028c57b..b6fa031761 100644
--- a/wsutil/wsjson.h
+++ b/wsutil/wsjson.h
@@ -1,4 +1,5 @@
-/* wsjson.h
+/** @file
+ *
  * JSON parsing functions.
  *
  * Copyright 2016, Dario Lombardo
diff --git a/wsutil/wslog.h b/wsutil/wslog.h
index a5e507a6db..e52c18625b 100644
--- a/wsutil/wslog.h
+++ b/wsutil/wslog.h
@@ -1,4 +1,5 @@
-/*
+/** @file
+ *
  * Copyright 2021, João Valverde <j@v6e.pt>
  *
  * Wireshark - Network traffic analyzer
diff --git a/wsutil/xtea.h b/wsutil/xtea.h
index 09a467cab3..af914f2613 100644
--- a/wsutil/xtea.h
+++ b/wsutil/xtea.h
@@ -1,4 +1,5 @@
-/* xtea.h
+/** @file
+ *
  * Implementation of XTEA cipher
  * By Ahmad Fatoum <ahmad[AT]a3f.at>
  * Copyright 2017 Ahmad Fatoum