Re: [RFC patches 02/13] sms_send_message: add a short roadmap

[Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>]

[-- Attachment #1: Type: text/plain, Size: 1858 bytes --]

On Fri, 2010-05-28 at 07:11 -0700, Marcel Holtmann wrote: 
> Hi Inaky,
> 
> > From: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
> > 
> > ---
> >  src/sms.c |   13 +++++++++++++
> >  1 files changed, 13 insertions(+), 0 deletions(-)
> > 
> > diff --git a/src/sms.c b/src/sms.c
> > index 3a1cff0..594481e 100644
> > --- a/src/sms.c
> > +++ b/src/sms.c
> > @@ -398,6 +398,19 @@ static struct tx_queue_entry *create_tx_queue_entry(GSList *msg_list)
> >  	return entry;
> >  }
> >  
> > +/*
> > + * Pre-process a SMS text message and deliver it [D-BUS' SendMessage()]
> > + *
> > + * @conn: D-BUS connection
> > + * @msg: message data (telephone number and text)
> > + * @data: SMS object to use for transmision
> > + *
> > + * An alphabet is chosen for the text and it (might be) segmented in
> > + * fragments by sms_text_prepare() into @msg_list. A queue list @entry
> > + * is created by create_tx_queue_entry() and g_queue_push_tail()
> > + * appends that entry to the SMS transmit queue. Then the tx_next()
> > + * function is scheduled to run to process the queue.
> > + */
> >  static DBusMessage *sms_send_message(DBusConnection *conn, DBusMessage *msg,
> >  					void *data)
> >  {
> 
> small comments here. So it is D-Bus. That is the official naming in
> documentation we settled on some time ago. Half of the documentation
> might be still using it wrongly, but we might wanna set a good example
> here.

Ack to that -- I'll do a S&R for all of those.

> I don't know how picky gtk-doc is about not having the : for title and
> the empty line after the title. However this is nicely readable inside
> the source code, so I am fine with it.

Actually I am thinking gtk-doc is probably not the best idea to settle
on...it's quite a pain to generate and quite limited. More on this
later.