osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Moshe Kaplan 2021-11-25 22:31:05 -05:00 committed by Wireshark GitLab Utility
parent 9cfce57ac0
commit 1c3a9af869
146 changed files with 151 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
epan/addr_resolv.h
View File

@ -1,4 +1,4 @@
/* addr_resolv.h
/** @file
* Definitions for network object lookup
*
* Laurent Deniel <laurent.deniel@free.fr>

2
epan/address.h
View File

@ -1,4 +1,4 @@
/* address.h
/** @file
* Definitions for structures storing addresses, and for the type of
* variables holding port-type values
*

2
epan/address_types.h
View File

@ -1,4 +1,4 @@
/* address_types.h
/** @file
* Definitions for address types
*
* Wireshark - Network traffic analyzer

3
epan/app_mem_usage.h
View File

@ -1,5 +1,4 @@
/*
* app_mem_usage.h
/** @file
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>

3
epan/asn1.h
View File

@ -1,4 +1,5 @@
/* asn1.h
/** @file
*
* Common data for ASN.1
* 2007 Anders Broman
*

2
epan/charsets.h
View File

@ -1,4 +1,4 @@
/* charsets.h
/** @file
* Routines for handling character sets
*
* Wireshark - Network traffic analyzer

2
epan/column-utils.h
View File

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

2
epan/column.h
View File

@ -1,4 +1,4 @@
/* column.h
/** @file
* Definitions for column handling routines
*
* Wireshark - Network traffic analyzer

2
epan/conversation_debug.h
View File

@ -1,4 +1,4 @@
/* conversation_debug.h
/** @file
* A file of debug printing stuff for conversation-related things,
* although really anything can use this so long as it includes this
* header file and defines DEBUG_CONVERSATION in conversation.c

2
epan/crc10-tvb.h
View File

@ -1,4 +1,4 @@
/* crc10-tvb.h
/** @file
* Declaration of CRC-10 tvbuff routines
*
* Wireshark - Network traffic analyzer

2
epan/crc16-tvb.h
View File

@ -1,4 +1,4 @@
/* crc16-tvb.h
/** @file
* Declaration of CRC-16 tvbuff routines
*
* 2004 Richard van der Hoff <richardv@mxtelecom.com>

2
epan/crc32-tvb.h
View File

@ -1,4 +1,4 @@
/* crc32-tvb.h
/** @file
* Declaration of CRC-32 tvbuff routines
*
* Wireshark - Network traffic analyzer

2
epan/crc6-tvb.h
View File

@ -1,4 +1,4 @@
/* crc6-tvb.h
/** @file
* Declaration of CRC-6 tvbuff routines
*
* Wireshark - Network traffic analyzer

2
epan/crypt/dot11decrypt_system.h
View File

@ -1,4 +1,4 @@
/* dot11decrypt_system.h
/** @file
*
* Copyright (c) 2006 CACE Technologies, Davis (California)
* All rights reserved.

2
epan/crypt/dot11decrypt_user.h
View File

@ -1,4 +1,4 @@
/* dot11decrypt_user.h
/** @file
*
* Copyright (c) 2006 CACE Technologies, Davis (California)
* All rights reserved.

2
epan/crypt/dot11decrypt_ws.h
View File

@ -1,4 +1,4 @@
/* dot11decrypt_ws.h
/** @file
*
* Copyright (c) 2006 CACE Technologies, Davis (California)
* All rights reserved.

3
epan/diam_dict.h
View File

@ -1,5 +1,4 @@
/*
** diam_dict.h
/** @file
** Diameter Dictionary Import Routines
**
** (c) 2007, Luis E. Garcia Ontanon <luis@ontanon.org>

2
epan/disabled_protos.h
View File

@ -1,4 +1,4 @@
/* disabled_protos.h
/** @file
* Declarations of routines for reading and writing protocols file that determine
* enabling and disabling of protocols.
*

2
epan/dtd_parse.h
View File

@ -1,4 +1,4 @@
/* dtd_parse.h
/** @file
* an XML dissector for Wireshark
* header file to declare functions defined in lexer and used in parser,
* or vice versa

2
epan/dvb_chartbl.h
View File

@ -1,4 +1,4 @@
/* dvb_chartbl.h
/** @file
* Routines for handling DVB-SI character tables (as defined in EN 300 468)
*
* Wireshark - Network traffic analyzer

2
epan/eap.h
View File

@ -1,4 +1,4 @@
/* eap.h
/** @file
* Extenal definitions for EAP Extensible Authentication Protocol dissection
* RFC 2284, RFC 3748
*

2
epan/epan.h
View File

@ -1,4 +1,4 @@
/* epan.h
/** @file
*
* Wireshark Protocol Analyzer Library
*

2
epan/epan_dissect.h
View File

@ -1,4 +1,4 @@
/* epan_dissect.h
/** @file
*
* Wireshark Protocol Analyzer Library
*

2
epan/etypes.h
View File

@ -1,4 +1,4 @@
/* etypes.h
/** @file
* Defines ethernet packet types, similar to tcpdump's ethertype.h
*
* Wireshark - Network traffic analyzer

3
epan/ex-opt.h
View File

@ -1,5 +1,4 @@
/*
* ex-opt.h
/** @file
*
* eXtension command line options
*

2
epan/expert.h
View File

@ -1,4 +1,4 @@
/* expert.h
/** @file
* Collecting of Expert information.
*
* For further info, see:

2
epan/export_object.h
View File

@ -1,4 +1,4 @@
/* export_object.h
/** @file
* GUI independent helper routines common to all export object taps.
*
* Wireshark - Network traffic analyzer

3
epan/exported_pdu.h
View File

@ -1,5 +1,4 @@
/*
* exported_pdu.h
/** @file
* Routines for exported_pdu dissection
* Copyright 2013, Anders Broman <anders-broman@ericsson.com>
*

2
epan/follow.h
View File

@ -1,4 +1,4 @@
/* follow.h
/** @file
*
* Copyright 1998 Mike Hall <mlh@io.com>
*

2
epan/frame_data_sequence.h
View File

@ -1,4 +1,4 @@
/* frame_data_sequence.h
/** @file
* Implements a sequence of frame_data structures
*
* Wireshark - Network traffic analyzer

2
epan/ftypes/ftypes.h
View File

@ -1,4 +1,4 @@
/* ftypes.h
/** @file
* Definitions for field types
*
* Wireshark - Network traffic analyzer

3
epan/funnel.h
View File

@ -1,5 +1,4 @@
/*
* funnel.h
/** @file
*
* EPAN's GUI mini-API
*

2
epan/golay.h
View File

@ -1,4 +1,4 @@
/*
/** @file
* Provides routines for encoding and decoding the extended Golay
* (24,12,8) code.
*

2
epan/guid-utils.h
View File

@ -1,4 +1,4 @@
/* guid-utils.h
/** @file
* Definitions for GUID handling
*
* Wireshark - Network traffic analyzer

2
epan/iana_charsets.h
View File

@ -1,4 +1,4 @@
/* iana_charsets.h
/** @file
*
* Declarations for IANA-registered character sets
*

2
epan/in_cksum.h
View File

@ -1,4 +1,4 @@
/* in_cksum.h
/** @file
* Declaration of Internet checksum routine.
*
* Copyright (c) 1988, 1992, 1993

2
epan/ipproto.h
View File

@ -1,4 +1,4 @@
/* ipproto.h
/** @file
* Declarations of IP protocol numbers, and of routines for converting
* IP protocol numbers into strings.
*

2
epan/ipv4.h
View File

@ -1,4 +1,4 @@
/* ipv4.h
/** @file
* Definitions of IPv4 address-and-mask structure, which is what an
* FT_IPV4 value is (even if there's no mask in a packet, those
* values can be compared against an address+mask in a filter

2
epan/ipv6.h
View File

@ -1,4 +1,4 @@
/* ipv6.h
/** @file
* Definitions of IPv6 address-and-prefix structure, which is what an
* FT_IPV6 value is (even if there's no prefix in a packet, those
* values can be compared against an address+prefix in a filter

2
epan/maxmind_db.h
View File

@ -1,4 +1,4 @@
/* maxmind_db.h
/** @file
* Maxmind database support
*
* Copyright 2018, Gerald Combs <gerald@wireshark.org>

2
epan/media_params.h
View File

@ -1,4 +1,4 @@
/* media_params.h
/** @file
* Routines for parsing media type parameters as per RFC 822 and RFC 2045
* Copyright 2004, Anders Broman.
* Copyright 2004, Olivier Biot.

2
epan/next_tvb.h
View File

@ -1,4 +1,4 @@
/* next_tvb.h
/** @file
* Definitions for "next tvb" list
*
* Wireshark - Network traffic analyzer

2
epan/packet.h
View File

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

2
epan/plugin_if.h
View File

@ -1,4 +1,4 @@
/* plugin_if.h
/** @file
* An API for Wireshark plugins
*
* This enables wireshark dissectors, especially those implemented by plugins

2
epan/ppptypes.h
View File

@ -1,4 +1,4 @@
/* ppptypes.h
/** @file
* Defines PPP packet types.
*
* Wireshark - Network traffic analyzer

2
epan/print.h
View File

@ -1,4 +1,4 @@
/* print.h
/** @file
* Definitions for printing packet analysis trees.
*
* Gilbert Ramirez <gram@alumni.rice.edu>

2
epan/print_stream.h
View File

@ -1,4 +1,4 @@
/* print_stream.h
/** @file
* Definitions for print streams.
*
* Gilbert Ramirez <gram@alumni.rice.edu>

2
epan/protobuf_lang_tree.h
View File

@ -1,4 +1,4 @@
/* protobuf_lang_tree.h
/** @file
*
* Routines of building and reading Protocol Buffers Language grammar tree.
* Copyright 2019, Huang Qiangxiong <qiangxiong.huang@qq.com>

2
epan/ptvcursor.h
View File

@ -1,4 +1,4 @@
/* ptvcursor.h
/** @file
*
* Proto Tree TVBuff cursor
* Gilbert Ramirez <gram@alumni.rice.edu>

2
epan/reassemble.h
View File

@ -1,4 +1,4 @@
/* reassemble.h
/** @file
* Declarations of routines for {fragment,segment} reassembly
*
* Wireshark - Network traffic analyzer

2
epan/reedsolomon.h
View File

@ -1,4 +1,4 @@
/* reedsolomon.h
/** @file
*
* Global definitions for Reed-Solomon encoder/decoder,
* by Phil Karn (karn@ka9q.ampr.org) September 1996

2
epan/register-int.h
View File

@ -1,4 +1,4 @@
/* register-int.h
/** @file
* Definitions for protocol registration
*
* Wireshark - Network traffic analyzer

2
epan/req_resp_hdrs.h
View File

@ -1,4 +1,4 @@
/* req_resp_hdrs.h
/** @file
* Declarations of routines handling protocols with a request/response line,
* headers, a blank line, and an optional body.
*

2
epan/rtd_table.h
View File

@ -1,4 +1,4 @@
/* rtd_table.h
/** @file
* GUI independent helper routines common to all Response Time Delay (RTD) taps.
* Based on srt_table.h
*

2
epan/rtp_pt.h
View File

@ -1,4 +1,4 @@
/* rtp_pt.h
/** @file
* Defines RTP payload types
*
* Wireshark - Network traffic analyzer

2
epan/sctpppids.h
View File

@ -1,4 +1,4 @@
/* sctpppids.h
/** @file
* Declarations of SCTP payload protocol IDs.
*
* Copyright 2011-2021 by Thomas Dreibholz <dreibh [AT] iem.uni-due.de>

2
epan/secrets.h
View File

@ -1,4 +1,4 @@
/* secrets.h
/** @file
* Secrets management and processing.
* Copyright 2018, Peter Wu <peter@lekensteyn.nl>
*

2
epan/sequence_analysis.h
View File

@ -1,4 +1,4 @@
/* sequence-analysis.h
/** @file
* Flow sequence analysis
*
* Copied from gtk/graph_analysis.h

2
epan/show_exception.h
View File

@ -1,4 +1,4 @@
/* show_exception.h
/** @file
*
* Routines to put exception information into the protocol tree
*

2
epan/srt_table.h
View File

@ -1,4 +1,4 @@
/* srt_table.h
/** @file
* GUI independent helper routines common to all service response time (SRT) taps.
*
* Wireshark - Network traffic analyzer

2
epan/stat_tap_ui.h
View File

@ -1,4 +1,4 @@
/* stat_tap_ui.h
/** @file
* Declarations of routines to register UI information for stats
*
* Wireshark - Network traffic analyzer

2
epan/stats_tree.h
View File

@ -1,4 +1,4 @@
/* stats_tree.h
/** @file
* A counter tree API for Wireshark dissectors
* 2005, Luis E. G. Ontanon
*

2
epan/stats_tree_priv.h
View File

@ -1,4 +1,4 @@
/* stats_tree_priv.h
/** @file
* implementor's API for stats_tree
* 2005, Luis E. G. Ontanon
*

2
epan/stream.h
View File

@ -1,4 +1,4 @@
/* stream.h
/** @file
*
* Definititions for handling circuit-switched protocols
* which are handled as streams, and don't have lengths

2
epan/tap.h
View File

@ -1,4 +1,4 @@
/* tap.h
/** @file
* packet tap interface 2002 Ronnie Sahlberg
*
* Wireshark - Network traffic analyzer

2
epan/timestamp.h
View File

@ -1,4 +1,4 @@
/* timestamp.h
/** @file
* Defines for packet timestamps
*
* Wireshark - Network traffic analyzer

2
epan/timestats.h
View File

@ -1,4 +1,4 @@
/* timestats.h
/** @file
* Routines and definitions for time statistics
* Copyright 2003 Lars Roland
*

2
epan/to_str.h
View File

@ -1,4 +1,4 @@
/* to_str.h
/** @file
* Definitions for utilities to convert various other types to strings.
*
* Wireshark - Network traffic analyzer

2
epan/tvbparse.h
View File

@ -1,4 +1,4 @@
/* tvbparse.h
/** @file
*
* an API for text tvb parsers
*

2
epan/tvbuff-int.h
View File

@ -1,4 +1,4 @@
/* tvbuff-int.h
/** @file
*
* Structures that most TVB users should not be accessing directly.
*

2
epan/tvbuff.h
View File

@ -1,4 +1,4 @@
/* tvbuff.h
/** @file
*
* Testy, Virtual(-izable) Buffer of guint8*'s
*

3
epan/uat-int.h
View File

@ -1,5 +1,4 @@
/*
* uat-int.h
/** @file
*
* User Accessible Tables
* Maintain an array of user accessible data structures

3
epan/uat.h
View File

@ -1,5 +1,4 @@
/*
* uat.h
/** @file
*
* User Accessible Tables
* Maintain an array of user accessible data structures

2
epan/value_string.h
View File

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

2
epan/wmem_scopes.h
View File

@ -1,4 +1,4 @@
/* wmem_scopes.h
/** @file
* Definitions for the Wireshark Memory Manager Scopes
* Copyright 2012, Evan Huus <eapache@gmail.com>
*

2
epan/wscbor.h
View File

@ -1,4 +1,4 @@
/* wscbor.h
/** @file
* Definitions for the Wireshark CBOR item decoding API.
* References:
* RFC 8949: https://tools.ietf.org/html/rfc8949

3
epan/wslua/init_wslua.h
View File

@ -1,5 +1,4 @@
/*
* init_wslua.h
/** @file
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>

3
epan/wslua/wslua_file_common.h
View File

@ -1,5 +1,4 @@
/*
* wslua_file_common.h
/** @file
*
* Wireshark's interface to the Lua Programming Language
* for file handling related source files.

3
epan/wslua/wslua_pinfo_common.h
View File

@ -1,5 +1,4 @@
/*
* wslua_pinfo_common.h
/** @file
*
* Wireshark's interface to the Lua Programming Language
*

2
include/ws_symbol_export.h
View File

@ -1,4 +1,4 @@
/*
/** @file
* Cross platform defines for exporting symbols from shared libraries
*
* Wireshark - Network traffic analyzer

2
wiretap/file_wrappers.h
View File

@ -1,4 +1,4 @@
/* file_wrappers.h
/** @file
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

2
wiretap/merge.h
View File

@ -1,4 +1,4 @@
/* merge.h
/** @file
* Definitions for routines for merging files.
*
* Wireshark - Network traffic analyzer

2
wiretap/pcap-encap.h
View File

@ -1,4 +1,4 @@
/* pcap-encap.h
/** @file
* Declarations for routines to handle pcap/pcapng linktype values
*
* Wiretap Library

2
wiretap/pcapng_module.h
View File

@ -1,4 +1,4 @@
/* pcap_module.h
/** @file
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

2
wiretap/wtap-int.h
View File

@ -1,4 +1,4 @@
/* wtap-int.h
/** @file
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

2
wiretap/wtap.h
View File

@ -1,4 +1,4 @@
/* wtap.h
/** @file
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

2
wiretap/wtap_opttypes.h
View File

@ -1,4 +1,4 @@
/* wtap_opttypes.h
/** @file
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>

2
wsutil/adler32.h
View File

@ -1,4 +1,4 @@
/* adler32.h
/** @file
* Compute the Adler32 checksum (RFC 1950)
* 2003 Tomas Kukosa
*

2
wsutil/base32.h
View File

@ -1,4 +1,4 @@
/* base32.h
/** @file
* Base-32 conversion
*
* Wireshark - Network traffic analyzer

2
wsutil/bitswap.h
View File

@ -1,4 +1,4 @@
/* bitswap.h
/** @file
* Macro to bitswap a byte by looking it up in a table
*
* Wireshark - Network traffic analyzer

2
wsutil/buffer.h
View File

@ -1,4 +1,4 @@
/* buffer.h
/** @file
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>

2
wsutil/cfutils.h
View File

@ -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.

2
wsutil/codecs.h
View File

@ -1,4 +1,4 @@
/* codecs.h
/** @file
* codecs interface 2007 Tomas Kukosa
*
* Wireshark - Network traffic analyzer

2
wsutil/copyright_info.h
View File

@ -1,4 +1,4 @@
/* copyright_info.h
/** @file
* Declarations of outines to report copyright information for stuff used
* by Wireshark
*

2
wsutil/cpu_info.h
View File

@ -1,4 +1,4 @@
/* cpu_info.h
/** @file
* Declarations of routines to report CPU information
*
* Wireshark - Network traffic analyzer

2
wsutil/crash_info.h
View File

@ -1,4 +1,4 @@
/* crash_info.h
/** @file
* Routines to try to provide more useful information in crash dumps.
*
* Wireshark - Network traffic analyzer

3
wsutil/crc10.h
View File

@ -1,5 +1,4 @@
/*
* crc10.h
/** @file
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>

3
wsutil/crc11.h
View File

@ -1,5 +1,4 @@
/*
* crc11.h
/** @file
* http://www.tty1.net/pycrc/faq_en.html#code-ownership
*
* Wireshark - Network traffic analyzer

3
wsutil/crc16-plain.h
View File

@ -1,5 +1,4 @@
/*
* crc16-plain.h
/** @file
* http://www.tty1.net/pycrc/faq_en.html#code-ownership
*
* Wireshark - Network traffic analyzer

2
wsutil/crc16.h
View File

@ -1,4 +1,4 @@
/* crc16.h
/** @file
* Declaration of CRC-16 routines and table
*
* 2004 Richard van der Hoff <richardv@mxtelecom.com>

Some files were not shown because too many files have changed in this diff Show More