aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--gtk/color_utils.c7
-rw-r--r--gtk/main.h2
-rw-r--r--gtk/main_toolbar.h2
-rw-r--r--gtk/new_packet_list.c2
-rw-r--r--gtk/new_packet_list.h12
-rw-r--r--gtk/packet_list_store.h33
-rw-r--r--gtk/prefs_column.h2
-rw-r--r--gtk/prefs_dlg.h16
-rw-r--r--gtk/prefs_gui.h2
-rw-r--r--gtk/prefs_layout.h2
10 files changed, 45 insertions, 35 deletions
diff --git a/gtk/color_utils.c b/gtk/color_utils.c
index 8a7142bb3b..e865571272 100644
--- a/gtk/color_utils.c
+++ b/gtk/color_utils.c
@@ -131,13 +131,12 @@ gdkcolor_to_color_t(color_t *target, const GdkColor *source)
#else
/** Copied from GTK sources
* gdk_color_to_string:
- * @param color a #GdkColor
- *
* Returns a textual specification of parameter color in the hexadecimal form
- * \c#rrrrggggbbbb\c, where \c r \c,
- * \c g \c and \c b \c are hex digits
+ * \c #rrrrggggbbbb \c , where \c r \c ,
+ * \c g \c and \c b \c are hex digits
* representing the red, green and blue components respectively.
*
+ * @param color a #GdkColor
* @return a newly-allocated text string
*
* Since: 2.12
diff --git a/gtk/main.h b/gtk/main.h
index bf2cc16893..4b35189908 100644
--- a/gtk/main.h
+++ b/gtk/main.h
@@ -34,7 +34,7 @@
node [shape=record, fontname=Helvetica, fontsize=10];
main [ label="main window" URL="\ref main.h"];
menu [ label="menubar" URL="\ref menus.h"];
- toolbar [ label="toolbar" URL="\ref toolbar.h"];
+ toolbar [ label="toolbar" URL="\ref main_toolbar.h"];
packet_list [ label="packet list pane" URL="\ref main_packet_list.h"];
proto_draw [ label="packet details & bytes panes" URL="\ref main_proto_draw.h"];
recent [ label="recent user settings" URL="\ref recent.h"];
diff --git a/gtk/main_toolbar.h b/gtk/main_toolbar.h
index 42c32bd6e1..6c040f9660 100644
--- a/gtk/main_toolbar.h
+++ b/gtk/main_toolbar.h
@@ -1,4 +1,4 @@
-/* toolbar.h
+/* main_toolbar.h
* Definitions for toolbar utility routines
* Copyright 2003, Ulf Lamping <ulf.lamping@web.de>
*
diff --git a/gtk/new_packet_list.c b/gtk/new_packet_list.c
index 4aba5f9cf9..40d98fbd00 100644
--- a/gtk/new_packet_list.c
+++ b/gtk/new_packet_list.c
@@ -109,7 +109,7 @@ new_packet_list_create(void)
return scrollwin;
}
-/* XXX - implement a smarter solution for recreating the packet list */
+/** @todo XXX - implement a smarter solution for recreating the packet list */
void
new_packet_list_recreate(void)
{
diff --git a/gtk/new_packet_list.h b/gtk/new_packet_list.h
index bc9cddf979..9520809186 100644
--- a/gtk/new_packet_list.h
+++ b/gtk/new_packet_list.h
@@ -28,6 +28,10 @@
#ifdef NEW_PACKET_LIST
#include <gtk/gtk.h>
+/** @file
+ * @ingroup main_window_group
+ */
+
#define RECENT_KEY_COL_WIDTH "column.width"
typedef enum {
@@ -45,7 +49,9 @@ typedef enum {
COLUMN_SELECTED_REMOVE
} COLUMN_SELECTED_E;
+/** Create the packet list */
GtkWidget *new_packet_list_create(void);
+/** Recreate the packetr list */
void new_packet_list_recreate(void);
void new_packet_list_toggle_visible_column (gint col_id);
void new_packet_list_set_all_columns_visible (void);
@@ -109,10 +115,10 @@ extern void new_packet_list_unignore_all_frames_cb(GtkWidget *w _U_, gpointer da
*/
extern void new_packet_list_untime_reference_all_frames_cb(GtkWidget *w _U_, gpointer data _U_);
-/* Different modes of copying summary data */
+/** Different modes of copying summary data */
typedef enum {
- CS_TEXT, /* Packet summary data (tab separated) */
- CS_CSV /* Packet summary data (comma separated) */
+ CS_TEXT, /**< Packet summary data (tab separated) */
+ CS_CSV /**< Packet summary data (comma separated) */
} copy_summary_type;
/** Called when user clicks on menu item to copy summary data.
diff --git a/gtk/packet_list_store.h b/gtk/packet_list_store.h
index 7485f8b426..5fd029bf33 100644
--- a/gtk/packet_list_store.h
+++ b/gtk/packet_list_store.h
@@ -35,6 +35,10 @@
#include "epan/column_info.h"
#include "epan/frame_data.h"
+/** @file
+ * The packet list store
+ * @ingroup main_window_group
+ */
#define PACKETLIST_TYPE_LIST (packet_list_get_type())
#define PACKET_LIST(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PACKETLIST_TYPE_LIST, PacketList))
#define PACKETLIST_LIST_CLASS(klass) (G_TYPE_CHECK_CLASS_CART((klass), PACKETLIST_TYPE_LIST))
@@ -52,54 +56,55 @@ typedef struct _PacketListClass PacketListClass;
#define PACKET_LIST_RECORD_COUNT(rows) ((rows) ? (rows)->len : 0)
#define PACKET_LIST_RECORD_INDEX_VALID(rows, idx) ((rows) ? (((guint) (idx)) < (rows)->len) : FALSE)
-/* PacketListRecord: represents a row */
+/** PacketListRecord: represents a row */
struct _PacketListRecord
{
- /* Has this record been columnized? */
+ /** Has this record been columnized? */
gboolean columnized;
- /* Has this record been colorized? */
+ /** Has this record been colorized? */
gboolean colorized;
frame_data *fdata;
/* admin stuff used by the custom list model */
- /* position within the physical array */
+ /** position within the physical array */
guint physical_pos;
- /* position within the visible array */
+ /** position within the visible array */
gint visible_pos;
};
-/* PacketListRecord: Everything for our model implementation. */
+/** PacketListRecord: Everything for our model implementation. */
struct _PacketList
{
- GObject parent; /* MUST be first */
+ GObject parent; /** MUST be first */
+ /** Array of pointers to the PacketListRecord structure for each visible row. */
GPtrArray *visible_rows;
- /* Array of pointers to the PacketListRecord structure for each row. */
+ /** Array of pointers to the PacketListRecord structure for each row. */
GPtrArray *physical_rows;
- /* Has the entire file been columnized? */
+ /** Has the entire file been columnized? */
gboolean columnized;
gint n_columns;
- /* Note: We need one extra column to store the entire PacketListRecord */
+ /**< Note: We need one extra column to store the entire PacketListRecord */
GType column_types[NUM_COL_FMTS+1];
- GtkWidget *view; /* XXX - Does this really belong here?? */
+ GtkWidget *view; /**< @todo XXX - Does this really belong here?? */
gint sort_id;
GtkSortType sort_order;
GStringChunk *string_pool;
- /* Random integer to check whether an iter belongs to our model. */
+ /** Random integer to check whether an iter belongs to our model. */
gint stamp;
#ifdef NEW_PACKET_LIST_STATISTICS
- /* Statistics */
+ /** Statistics */
guint const_strings;
#endif
};
-/* PacketListClass: more boilerplate GObject stuff */
+/** PacketListClass: more boilerplate GObject stuff */
struct _PacketListClass
{
GObjectClass parent_class;
diff --git a/gtk/prefs_column.h b/gtk/prefs_column.h
index e833b8619b..639308616f 100644
--- a/gtk/prefs_column.h
+++ b/gtk/prefs_column.h
@@ -1,4 +1,4 @@
-/* column_prefs.h
+/* prefs_column.h
* Definitions for column preferences window
*
* $Id$
diff --git a/gtk/prefs_dlg.h b/gtk/prefs_dlg.h
index b89f68fdc0..dca73eb296 100644
--- a/gtk/prefs_dlg.h
+++ b/gtk/prefs_dlg.h
@@ -35,14 +35,14 @@
digraph prefs_pages {
node [shape=record, fontname=Helvetica, fontsize=10];
dialog [ label="Preferences dialog" URL="\ref prefs_dlg.h"];
- ui [ label="User Interface" URL="\ref gui_prefs.h"];
- layout [ label="UI: Layout" URL="\ref layout_prefs.h"];
- columns [ label="UI: Columns" URL="\ref column_prefs.h"];
- font [ label="UI: Font" URL="\ref gui_prefs.h"];
- colors [ label="UI: Colors" URL="\ref stream_prefs.h"];
- capture [ label="Capture" URL="\ref capture_prefs.h"];
- print [ label="Printing" URL="\ref print_prefs.h"];
- nameres [ label="Name resolution" URL="\ref nameres_prefs.h"];
+ ui [ label="User Interface" URL="\ref prefs_gui.h"];
+ layout [ label="UI: Layout" URL="\ref prefs_layout.h"];
+ columns [ label="UI: Columns" URL="\ref prefs_column.h"];
+ font [ label="UI: Font" URL="\ref prefs_gui.h"];
+ colors [ label="UI: Colors" URL="\ref prefs_stream.h"];
+ capture [ label="Capture" URL="\ref prefs_capture.h"];
+ print [ label="Printing" URL="\ref prefs_print.h"];
+ nameres [ label="Name resolution" URL="\ref prefs_nameres.h"];
protocols [ label="Protocols" URL="\ref prefs_dlg.h"];
dialog -> ui [ arrowhead="open", style="solid" ];
dialog -> layout [ arrowhead="open", style="solid" ];
diff --git a/gtk/prefs_gui.h b/gtk/prefs_gui.h
index 2832220fb0..f337ede8f2 100644
--- a/gtk/prefs_gui.h
+++ b/gtk/prefs_gui.h
@@ -1,4 +1,4 @@
-/* gui_prefs.h
+/* prefs_gui.h
* Definitions for GUI preferences window
*
* $Id$
diff --git a/gtk/prefs_layout.h b/gtk/prefs_layout.h
index 89b64d086b..427b1be591 100644
--- a/gtk/prefs_layout.h
+++ b/gtk/prefs_layout.h
@@ -1,4 +1,4 @@
-/* layout_prefs.h
+/* prefs_layout.h
* Definitions for layout preferences window
*
* $Id$
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-09 18:53:36 +0000