From 3457adefefa8bedd0349e6ac3d5cebcacf958000 Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Thu, 4 Mar 2010 17:28:36 -0800 Subject: gsm: clarify generic GSM subclass API a bit --- src/mm-generic-gsm.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/mm-generic-gsm.h b/src/mm-generic-gsm.h index de0b00b7..4f190f8b 100644 --- a/src/mm-generic-gsm.h +++ b/src/mm-generic-gsm.h @@ -59,7 +59,10 @@ typedef struct { * that need to perform custom initialization sequences or other setup should * generally override this method instead of the MMModem interface's enable() * method, unless the customization must happen *after* the generic init - * sequence has completed. + * sequence has completed. When the subclass' enable attempt is complete + * the subclass should call mm_generic_gsm_enable_complete() with any error + * encountered during the process and the MMCallbackInfo created from the + * callback and user_data passed in here. */ void (*do_enable) (MMGenericGsm *self, MMModemFn callback, gpointer user_data); } MMGenericGsmClass; -- cgit v1.2.3-70-g09d2