extcap: Add header files to Doxygen

Add @file markers for extcap headers so that Doxygen will generate documentation for them.
wireshark · Nov 30, 2021 · fd5b5e3 · fd5b5e3
1 parent 5d4eb4b
commit fd5b5e3
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 9 deletions.
diff --git a/extcap.h b/extcap.h
@@ -1,4 +1,5 @@
-/* extcap.h
+/** @file
+ *
  * Definitions for extcap external capture
  * Copyright 2013, Mike Ryan <mikeryan@lacklustre.net>
  *

diff --git a/extcap/dpauxmon_user.h b/extcap/dpauxmon_user.h
@@ -1,4 +1,5 @@
-/*
+/** @file
+ *
  * Copyright 2018, Dirk Eibach, Guntermann & Drunck GmbH <dirk.eibach@gdsys.cc>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later

diff --git a/extcap/etl.h b/extcap/etl.h
@@ -1,5 +1,5 @@
-/* etl.h
-*
+/** @file
+ *
  * Copyright 2020, Odysseus Yang
  *
  * Wireshark - Network traffic analyzer

diff --git a/extcap/etw_message.h b/extcap/etw_message.h
@@ -1,5 +1,5 @@
-/* etl.h
-*
+/** @file
+ *
  * Copyright 2020, Odysseus Yang
  *
  * Wireshark - Network traffic analyzer

diff --git a/extcap/extcap-base.h b/extcap/extcap-base.h
@@ -1,4 +1,5 @@
-/* extcap_base.h
+/** @file
+ *
  * Base function for extcaps
  *
  * Copyright 2016, Dario Lombardo

diff --git a/extcap/ssh-base.h b/extcap/ssh-base.h
@@ -1,4 +1,5 @@
-/* ssh-base.h
+/** @file
+ *
  * ssh-base has base utility functions to connect to hosts via ssh
  *
  * Copyright 2016, Dario Lombardo

diff --git a/extcap_parser.h b/extcap_parser.h
@@ -1,4 +1,4 @@
-/* extcap_parser.h
+/** @file
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>