diff options
| author | Moshe Kaplan <me@moshekaplan.com> | 2021-11-29 22:08:22 -0500 |
|---|---|---|
| committer | Wireshark GitLab Utility <gerald+gitlab-utility@wireshark.org> | 2021-11-30 06:27:26 +0000 |
| commit | 65a651d5b91f8bce08054e0ac575e68f978c561a (patch) | |
| tree | c33af74420ef43362202349f00fcd70b046b98dd | |
| parent | 34454a5037e6059e06ba81516f50f676b4d0c494 (diff) | |
capture: Add header files to Doxygen
Add @file markers for capture
headers so that Doxygen will
generate documentation for them.
Additionally, update the doxygen
config file per
7fee50274f36a5feba113aa9ad3e72ca37bf1466
merging the caputils and capchild
directories.
| -rw-r--r-- | capture/airpcap.h | 3 | ||||
| -rw-r--r-- | capture/airpcap_loader.h | 3 | ||||
| -rw-r--r-- | capture/capture-pcap-util-int.h | 3 | ||||
| -rw-r--r-- | capture/capture-pcap-util.h | 3 | ||||
| -rw-r--r-- | capture/capture-wpcap.h | 2 | ||||
| -rw-r--r-- | capture/capture_ifinfo.h | 3 | ||||
| -rw-r--r-- | capture/capture_session.h | 3 | ||||
| -rw-r--r-- | capture/capture_win_ifnames.h | 3 | ||||
| -rw-r--r-- | capture/iface_monitor.h | 3 | ||||
| -rw-r--r-- | capture/ws80211_utils.h | 3 | ||||
| -rw-r--r-- | doxygen.cfg.in | 3 |
11 files changed, 20 insertions, 12 deletions
diff --git a/capture/airpcap.h b/capture/airpcap.h index 9ca0688834..8cbc956948 100644 --- a/capture/airpcap.h +++ b/capture/airpcap.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Copyright (c) 2006-2007 CACE Technologies, Davis (California) * All rights reserved. * diff --git a/capture/airpcap_loader.h b/capture/airpcap_loader.h index c1d612bd9f..8cec4ddba6 100644 --- a/capture/airpcap_loader.h +++ b/capture/airpcap_loader.h @@ -1,4 +1,5 @@ -/* airpcap_loader.h +/** @file + * * Declarations of routines for the "About" dialog * * Giorgio Tino <giorgio.tino@cacetech.com> diff --git a/capture/capture-pcap-util-int.h b/capture/capture-pcap-util-int.h index d2e59a42bc..2961a2446c 100644 --- a/capture/capture-pcap-util-int.h +++ b/capture/capture-pcap-util-int.h @@ -1,4 +1,5 @@ -/* capture-pcap-util-int.h +/** @file + * * Definitions of routines internal to the libpcap/WinPcap/Npcap utilities * * Wireshark - Network traffic analyzer diff --git a/capture/capture-pcap-util.h b/capture/capture-pcap-util.h index 914b5ad411..595f6eb50e 100644 --- a/capture/capture-pcap-util.h +++ b/capture/capture-pcap-util.h @@ -1,4 +1,5 @@ -/* capture-pcap-util.h +/** @file + * * Utility definitions for packet capture * * Wireshark - Network traffic analyzer diff --git a/capture/capture-wpcap.h b/capture/capture-wpcap.h index 3e18a79de4..a6affdab25 100644 --- a/capture/capture-wpcap.h +++ b/capture/capture-wpcap.h @@ -1,4 +1,4 @@ -/* capture-wpcap.h +/** @file * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> diff --git a/capture/capture_ifinfo.h b/capture/capture_ifinfo.h index 5034ddb720..7082f686de 100644 --- a/capture/capture_ifinfo.h +++ b/capture/capture_ifinfo.h @@ -1,4 +1,5 @@ -/* capture_ifinfo.h +/** @file + * * Definitions for routines to get information about capture interfaces * * Wireshark - Network traffic analyzer diff --git a/capture/capture_session.h b/capture/capture_session.h index 36773a5daf..4c906207ad 100644 --- a/capture/capture_session.h +++ b/capture/capture_session.h @@ -1,4 +1,5 @@ -/* capture_session.h +/** @file + * * State of a capture session * * Wireshark - Network traffic analyzer diff --git a/capture/capture_win_ifnames.h b/capture/capture_win_ifnames.h index 9289d2499f..df73968ca2 100644 --- a/capture/capture_win_ifnames.h +++ b/capture/capture_win_ifnames.h @@ -1,4 +1,5 @@ -/* capture_win_ifnames.h +/** @file + * * Routines supporting the use of Windows friendly interface names within Wireshark * Copyright 2011-2012, Mike Garratt <wireshark@evn.co.nz> * diff --git a/capture/iface_monitor.h b/capture/iface_monitor.h index fa1ac77a2f..61a7ea1bbc 100644 --- a/capture/iface_monitor.h +++ b/capture/iface_monitor.h @@ -1,4 +1,5 @@ -/* iface_monitor.h +/** @file + * * interface monitor by Pontus Fuchs <pontus.fuchs@gmail.com> * * Wireshark - Network traffic analyzer diff --git a/capture/ws80211_utils.h b/capture/ws80211_utils.h index 96c3c2c520..f0f7525382 100644 --- a/capture/ws80211_utils.h +++ b/capture/ws80211_utils.h @@ -1,4 +1,5 @@ -/* +/** @file + * * Copyright 2012, Pontus Fuchs <pontus.fuchs@gmail.com> * * Wireshark - Network traffic analyzer diff --git a/doxygen.cfg.in b/doxygen.cfg.in index c70edff0c9..9159c2b037 100644 --- a/doxygen.cfg.in +++ b/doxygen.cfg.in @@ -832,8 +832,7 @@ WARN_LOGFILE = # ls */*.h | xargs -n1 dirname | sort -u INPUT = @DOXYGEN_INPUT_DIRECTORY@/wireshark.dox \ @DOXYGEN_TOP_LEVEL_SOURCES@ \ - @DOXYGEN_INPUT_DIRECTORY@/capchild \ - @DOXYGEN_INPUT_DIRECTORY@/caputils \ + @DOXYGEN_INPUT_DIRECTORY@/capture \ @DOXYGEN_INPUT_DIRECTORY@/epan \ @DOXYGEN_INPUT_DIRECTORY@/extcap \ @DOXYGEN_INPUT_DIRECTORY@/plugins \ |