Updated documentation for 0.2 release
[mtetherd] / hal.h
diff --git a/hal.h b/hal.h
index 3ebccc1..ffdaeba 100644 (file)
--- a/hal.h
+++ b/hal.h
 #include <libhal.h>
 #include "plugin.h"
 
+// Initialize DBUS and HAL connection
 gboolean mtetherd_hal_init(MTetherDStatusPlugin *plugin);
+// Release resources required for HAL connection
 void mtetherd_hal_finalize(MTetherDStatusPlugin *plugin);
+// Scan the HAL network interface list and call
+// mtetherd_status_plugin_device_added() for each device
 void mtetherd_hal_device_scan(MTetherDStatusPlugin *plugin);
+// Check the USB cable state
+// Returns TRUE if plugged in, FALSE if not
+gboolean mtetherd_usb_state(MTetherDStatusPlugin *plugin);
 
 #endif //_MTETHERD_HAL_H