rtd_table(.h): fix api reference

[metze/wireshark/wip.git] / epan / rtd_table.h

diff --git a/epan/rtd_table.h b/epan/rtd_table.h
index 267fe9325417bd547a4aecb63207148b12204cb5..570632658764dac6309148c09f89141d4dc731ae 100644 (file)
--- a/epan/rtd_table.h
+++ b/epan/rtd_table.h
@@ -52,7 +52,7 @@ typedef struct _rtd_stat_table {
  */
 typedef struct _rtd_data_t {
        rtd_stat_table  stat_table;  /**< RTD table data */
-       void        *user_data;       /**< "GUI" specifics (if necessary) */
+       void        *user_data;       /**< "GUI" specifics (GTK+ only) */
 } rtd_data_t;
 
 /** Structure for information about a registered service response table */
@@ -60,15 +60,16 @@ struct register_rtd;
 typedef struct register_rtd register_rtd_t;
 
 typedef void (*rtd_gui_init_cb)(rtd_stat_table* rtd, void* gui_data);
-typedef void (*rtd_gui_reset_cb)(rtd_stat_table* rtd, void* gui_data);
-typedef void (*rtd_gui_free_cb)(rtd_stat_table* rtd, void* gui_data);
-typedef void (*rtd_init_cb)(struct register_rtd* rtd, rtd_gui_init_cb gui_callback, void* gui_data);
+typedef void (*rtd_gui_reset_cb)(rtd_stat_table* rtd, void* gui_data); /* GTK+ only. */
+typedef void (*rtd_gui_free_cb)(rtd_stat_table* rtd, void* gui_data); /* GTK+ only. */
+typedef void (*rtd_init_cb)(struct register_rtd* rtd, rtd_gui_init_cb gui_callback, void* gui_data); /* GTK+ only. */
 typedef void (*rtd_filter_check_cb)(const char *opt_arg, const char **filter, char** err);
 
 /** Register the response time delay table.
  *
  * @param proto_id is the protocol with conversation
  * @param tap_listener string for register_tap_listener (NULL to just use protocol name)
+ * @param num_tables number of tables
  * @param num_timestats number of timestamps in the table
  * @param vs_type value_string for the stat types
  * @param rtd_packet_func the tap processing function
@@ -84,7 +85,7 @@ WS_DLL_PUBLIC void register_rtd_table(const int proto_id, const char* tap_listen
  */
 WS_DLL_PUBLIC int get_rtd_proto_id(register_rtd_t* rtd);
 
-/** Get string for register_tap_listener call.  Typically just dissector name
+/** Get string for register_tap_listener call. Typically just dissector name
  *
  * @param rtd Registered RTD
  * @return string for register_tap_listener call
@@ -98,6 +99,13 @@ WS_DLL_PUBLIC const char* get_rtd_tap_listener_name(register_rtd_t* rtd);
  */
 WS_DLL_PUBLIC tap_packet_cb get_rtd_packet_func(register_rtd_t* rtd);
 
+/** Get the number of RTD tables
+ *
+ * @param rtd Registered RTD
+ * @return The number of registered tables.
+ */
+WS_DLL_PUBLIC guint get_rtd_num_tables(register_rtd_t* rtd);
+
 /** Get value_string used for RTD
  *
  * @param rtd Registered RTD
@@ -114,12 +122,11 @@ WS_DLL_PUBLIC register_rtd_t* get_rtd_table_by_name(const char* name);
 
 /** Free the RTD table data.
  *
- * @param rtd Registered RTD
  * @param table RTD stat table array
  * @param gui_callback optional callback from GUI
  * @param callback_data callback data needed for GUI
  */
-WS_DLL_PUBLIC void free_rtd_table(register_rtd_t* rtd, rtd_stat_table* table, rtd_gui_free_cb gui_callback, void *callback_data);
+WS_DLL_PUBLIC void free_rtd_table(rtd_stat_table* table, rtd_gui_free_cb gui_callback, void *callback_data);
 
 /** Reset table data in the RTD.
  *