[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-devel
Subject:    Re: Review Request: libdebconf-kde
From:       "David Jarvie" <djarvie () kde ! org>
Date:       2010-07-26 8:31:40
Message-ID: 696868ed0c35c964cc1591ffdedf303f.squirrel () www ! sensical ! net
[Download RAW message or body]

On Sat, July 24, 2010 11:28 am, Albert Astals Cid wrote:
> A Dissabte, 24 de juliol de 2010, dantti85-dev@yahoo.com.br va escriure:
>> > > No, just DebconfGui.h which has a  d_ptr.
>> >
>> > Are you saying just by using DebconfGui.h i can use your library?  If
>> so
>> > it'll
>> >
>> > probably need some documentation because i'd be totally lost  when
>> trying
>> > to use it, all i can see i can do is create a widget and show  it, is
>> > that all (maybe it is don't know)?
>>
>> yes,
>> works like this, you create
>> debconfGui("/path/to/a/socket_to_be_created")
>> it emits a signal when a new connection has a question to show, so you
>> can
>> show the widget. It also has a signal to say that you show hide it.
>> quite simple.
>>
>> should I write an README?
>
> Yeah, for sure it'll help to anyone that wants to use your library.
>
> Albert
>
>>
>> thanks,
>> Daniel

The best place for information like that is in the apidox - the apidox
should provide sufficient information to understand when and how a class
or library should be used. READMEs are easy to overlook.

-- 
David Jarvie.
KDE developer.
KAlarm author - http://www.astrojar.org.uk/kalarm

 
>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<
[prev in list] [next in list] [prev in thread] [next in thread]