fix/add doxygen comments
svn path=/trunk/; revision=15941
This commit is contained in:
parent
512a4983c0
commit
a8ef1df32b
|
@ -393,7 +393,7 @@ extern gint tvb_pbrk_guint8(tvbuff_t *, gint offset, gint maxlength,
|
|||
*/
|
||||
extern guint tvb_strsize(tvbuff_t *tvb, gint offset);
|
||||
|
||||
/** Find length of string by looking for end of string ('\0'), up to
|
||||
/** Find length of string by looking for end of zero terminated string, up to
|
||||
* 'maxlength' characters'; if 'maxlength' is -1, searches to end
|
||||
* of tvbuff.
|
||||
* Returns -1 if 'maxlength' reached before finding EOS. */
|
||||
|
@ -430,7 +430,7 @@ extern gchar *tvb_format_stringzpad(tvbuff_t *tvb, gint offset, gint size);
|
|||
/**
|
||||
* Given a tvbuff, an offset, and a length, allocate a buffer big enough
|
||||
* to hold a non-null-terminated string of that length at that offset,
|
||||
* plus a trailing '\0', copy the string into it, and return a pointer
|
||||
* plus a trailing zero, copy the string into it, and return a pointer
|
||||
* to the string.
|
||||
*
|
||||
* Throws an exception if the tvbuff ends before the string does.
|
||||
|
|
|
@ -546,19 +546,19 @@ typedef enum {
|
|||
|
||||
/**
|
||||
* xmlCharEncodingInputFunc:
|
||||
* @out: a pointer ot an array of bytes to store the UTF-8 result
|
||||
* @outlen: the length of @out
|
||||
* @in: a pointer ot an array of chars in the original encoding
|
||||
* @inlen: the length of @in
|
||||
* @param out a pointer ot an array of bytes to store the UTF-8 result
|
||||
* @param outlen the length of out
|
||||
* @param in a pointer ot an array of chars in the original encoding
|
||||
* @param inlen the length of in
|
||||
*
|
||||
* Take a block of chars in the original encoding and try to convert
|
||||
* it to an UTF-8 block of chars out.
|
||||
*
|
||||
* Returns the number of byte written, or -1 by lack of space, or -2
|
||||
* if the transcoding failed.
|
||||
* The value of @inlen after return is the number of octets consumed
|
||||
* The value of inlen after return is the number of octets consumed
|
||||
* as the return value is positive, else unpredictiable.
|
||||
* The value of @outlen after return is the number of ocetes consumed.
|
||||
* The value of outlen after return is the number of ocetes consumed.
|
||||
*/
|
||||
typedef int (* xmlCharEncodingInputFunc)(unsigned char* out, int *outlen,
|
||||
const unsigned char* in, int *inlen);
|
||||
|
@ -566,10 +566,10 @@ typedef int (* xmlCharEncodingInputFunc)(unsigned char* out, int *outlen,
|
|||
|
||||
/**
|
||||
* xmlCharEncodingOutputFunc:
|
||||
* @out: a pointer ot an array of bytes to store the result
|
||||
* @outlen: the length of @out
|
||||
* @in: a pointer ot an array of UTF-8 chars
|
||||
* @inlen: the length of @in
|
||||
* @param out a pointer ot an array of bytes to store the result
|
||||
* @param outlen the length of out
|
||||
* @param in a pointer ot an array of UTF-8 chars
|
||||
* @param inlen the length of in
|
||||
*
|
||||
* Take a block of UTF-8 chars in and try to convert it to an other
|
||||
* encoding.
|
||||
|
@ -578,9 +578,9 @@ typedef int (* xmlCharEncodingInputFunc)(unsigned char* out, int *outlen,
|
|||
*
|
||||
* Returns the number of byte written, or -1 by lack of space, or -2
|
||||
* if the transcoding failed.
|
||||
* The value of @inlen after return is the number of octets consumed
|
||||
* The value of inlen after return is the number of octets consumed
|
||||
* as the return value is positive, else unpredictiable.
|
||||
* The value of @outlen after return is the number of ocetes consumed.
|
||||
* The value of outlen after return is the number of ocetes consumed.
|
||||
*/
|
||||
typedef int (* xmlCharEncodingOutputFunc)(unsigned char* out, int *outlen,
|
||||
const unsigned char* in, int *inlen);
|
||||
|
|
|
@ -22,6 +22,14 @@
|
|||
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
*/
|
||||
|
||||
/** @file
|
||||
* Capture "Interface Details" dialog box
|
||||
* @ingroup dialog_group
|
||||
*/
|
||||
|
||||
/** Open the dialog box.
|
||||
*
|
||||
* @param iface the interface name to show
|
||||
*/
|
||||
extern void capture_if_details_open(char *iface);
|
||||
|
||||
|
|
|
@ -22,6 +22,10 @@
|
|||
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
*/
|
||||
|
||||
/** @file
|
||||
* Capture filter combo box routines
|
||||
*/
|
||||
|
||||
extern void cfilter_combo_recent_write_all(FILE *rf);
|
||||
extern gboolean cfilter_combo_add_recent(gchar *s);
|
||||
|
||||
|
|
|
@ -25,12 +25,30 @@
|
|||
#ifndef __FILESET_DLG_H__
|
||||
#define __FILESET_DLG_H__
|
||||
|
||||
/** @file
|
||||
* "File Set" dialog box.
|
||||
* @ingroup dialog_group
|
||||
*/
|
||||
|
||||
/* start getting stats from all files */
|
||||
/** Open the fileset dialog.
|
||||
*
|
||||
* @param w calling widget (unused)
|
||||
* @param d data from calling widget (unused)
|
||||
*/
|
||||
extern void fileset_cb(GtkWidget *w, gpointer d);
|
||||
|
||||
/** Open the next file in the file set, or do nothing if already the last file.
|
||||
*
|
||||
* @param w calling widget (unused)
|
||||
* @param d data from calling widget (unused)
|
||||
*/
|
||||
extern void fileset_next_cb(GtkWidget *w, gpointer d);
|
||||
|
||||
/** Open the previous file in the file set, or do nothing if already the first file.
|
||||
*
|
||||
* @param w calling widget (unused)
|
||||
* @param d data from calling widget (unused)
|
||||
*/
|
||||
extern void fileset_previous_cb(GtkWidget *w, gpointer d);
|
||||
|
||||
#endif /* fileset_dlg.h */
|
||||
|
|
12
gtk/main.h
12
gtk/main.h
|
@ -51,16 +51,20 @@
|
|||
@enddot
|
||||
*/
|
||||
|
||||
extern GString *comp_info_str, *runtime_info_str;
|
||||
|
||||
/** @file
|
||||
* The main window, filter toolbar, program start/stop and a lot of other things
|
||||
* @ingroup main_window_group
|
||||
* @ingroup windows_group
|
||||
*/
|
||||
|
||||
/** Global capture options. */
|
||||
/** Global compile time version string */
|
||||
extern GString *comp_info_str;
|
||||
/** Global runtime version string */
|
||||
extern GString *runtime_info_str;
|
||||
|
||||
/** Global capture options type. */
|
||||
typedef struct capture_options_tag * p_capture_options_t;
|
||||
/** Pointer to global capture options. */
|
||||
extern p_capture_options_t capture_opts;
|
||||
|
||||
extern void protect_thread_critical_region(void);
|
||||
|
@ -281,7 +285,7 @@ extern gboolean main_filter_packets(capture_file *cf, const gchar *dftext,
|
|||
extern void dnd_init(GtkWidget *w);
|
||||
|
||||
/** Open a new file coming from drag and drop.
|
||||
* @param selection_data the selection data reported from GTK
|
||||
* @param cf_names_freeme the selection data reported from GTK
|
||||
*/
|
||||
extern void dnd_open_file_cmd(gchar *cf_names_freeme);
|
||||
|
||||
|
|
|
@ -39,14 +39,20 @@
|
|||
*/
|
||||
extern gboolean range_check_validity(packet_range_t *range);
|
||||
|
||||
#if GTK_MAJOR_VERSION < 2
|
||||
/** Create a new range widget.
|
||||
*
|
||||
* @param range the range to set
|
||||
#if GTK_MAJOR_VERSION < 2
|
||||
* @param accel_group accelerator group (GTK1 only)
|
||||
#endif
|
||||
* @return the new range widget
|
||||
*/
|
||||
#else
|
||||
/** Create a new range widget.
|
||||
*
|
||||
* @param range the range to set
|
||||
* @return the new range widget
|
||||
*/
|
||||
#endif
|
||||
extern GtkWidget *range_new(packet_range_t *range
|
||||
#if GTK_MAJOR_VERSION < 2
|
||||
, GtkAccelGroup *accel_group
|
||||
|
|
Loading…
Reference in New Issue