annotate doc/plugin-signals.dox @ 20550:28493a27849b

Looking at purple_contact_set_alias and purple_blist_alias_contact functions in blist.c, the only difference I see is that the latter function notifies any existing conversation with the contact so that it can update its title, while the former doesn't. I can't think of a reason why they should behave differently, or why we should have both of them. I was going to deprecate purple_blist_alias_contact in favour of purple_contact_set_alias, but seeing we do purple_blist_alias_ for buddy and chats, I am deprecating purple_contact_set_alias instead. OK?

/** @page plugin-signals Plugin Signals

 @signals
  @signal plugin-load
  @signal plugin-unload
 @endsignals

 <hr>

 @signaldef plugin-load
  @signalproto
void (*plugin_load)(PurplePlugin *plugin);
  @endsignalproto
  @signaldesc
   Emitted when a plugin is loaded.
  @param plugin The plugin that was loaded.
 @endsignaldef

 @signaldef plugin-unload
  @signalproto
void (*plugin_unload)(PurplePlugin *plugin);
  @endsignalproto
  @signaldesc
   Emitted when a plugin is unloaded.
  @param plugin The plugin that was unloaded.
 @endsignaldef

 */
// vim: syntax=c tw=75 et