minor comment additions

git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@13533 f5534014-38df-0310-8fa8-9805f1628bb7

diff --git a/capture.h b/capture.h
index 3da2757d2cade9200e8f35e129717e495082eaeb..a1e135944ef2e4675b849596afc927c6c43969f0 100644 (file)
--- a/capture.h
+++ b/capture.h
@@ -104,7 +104,8 @@ capture_opts_add_opt(capture_options *capture_opts, const char *appname, int opt
  */
 extern gboolean do_capture(capture_options *capture_opts);
 
-/** Do the low-level work of a capture (start the capture child). */
+/** Do the low-level work of a capture (start the capture child).
+ *  Returns TRUE if it succeeds, FALSE otherwise. */
 extern int  capture_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
 
 /** Stop a capture (usually from a menu item). */
@@ -113,7 +114,8 @@ extern void capture_stop(capture_options *capture_opts);
 /** Terminate the capture child cleanly when exiting. */
 extern void capture_kill_child(capture_options *capture_opts);
 
-/** Do the low-level work of a capture. */
+/** Do the low-level work of a capture.
+ *  Returns TRUE if it succeeds, FALSE otherwise. */
 extern int  capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
 
 /** Stop a low-level capture. */