depau/Purism-Calls
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/calls.git synced 2024-11-16 05:15:36 +00:00
Code Issues Releases Wiki Activity

best-match: Add gtk-doc annotations to the public API

Browse source 
Notably this adds ownership and nullable annotations, where appropriate.
This commit is contained in:
Evangelos Ribeiro Tzaras 2023-04-10 10:19:18 +02:00
parent 1b8ec26185
commit 343eb5919e
1 changed files with 39 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
src/calls-best-match.c
View file

@ -308,7 +308,12 @@ calls_best_match_init (CallsBestMatch *self)
{
}
/**
* calls_best_match_new:
* @number: The number to use for contact matching
*
* Returns: (transfer full): A new #CallsBestMatch
*/
CallsBestMatch *
calls_best_match_new (const char *number)
{
@ -317,6 +322,12 @@ calls_best_match_new (const char *number)
NULL);
}
/**
* calls_best_match_has_individual:
* @self: A #CallsBestMatch
*
* Returns: %TRUE if a contact was matched, %FALSE otherwise
*/
gboolean
calls_best_match_has_individual (CallsBestMatch *self)
{
@ -325,7 +336,6 @@ calls_best_match_has_individual (CallsBestMatch *self)
return !!self->matched_individual;
}
/**
* calls_best_match_is_favourite:
* @self: A #CallsBestMatch
@ -348,7 +358,12 @@ calls_best_match_is_favourite (CallsBestMatch *self)
return fav;
}
/**
* calls_best_match_get_phone_number:
* @self: A #CallsBestMatch
*
* Returns: (nullable): The phone number of @self, or %NULL if unknown.
*/
const char *
calls_best_match_get_phone_number (CallsBestMatch *self)
{
@ -357,7 +372,13 @@ calls_best_match_get_phone_number (CallsBestMatch *self)
return self->phone_number;
}
/**
* calls_best_match_set_phone_number:
* @self: A #CallsBestMatch
* @phone_number: (nullable): The phone number
*
* Set the @phone_number to use for matching.
*/
void
calls_best_match_set_phone_number (CallsBestMatch *self,
const char *phone_number)
@ -404,6 +425,14 @@ calls_best_match_set_phone_number (CallsBestMatch *self,
notify_display_info (self);
}
/**
* calls_best_match_get_name:
* @self: A #CallsBestMatch
*
* Returns: (nullable): The name of a matched individual,
* the display name or user portion of a SIP address,
* or %NULL otherwise.
*/
const char *
calls_best_match_get_name (CallsBestMatch *self)
{
@ -417,7 +446,12 @@ calls_best_match_get_name (CallsBestMatch *self)
return NULL;
}
/**
* calls_best_match_get_avatar:
* @self: A #CallsBestMatch
*
* Returns: (nullable): The avatar of a matched contact or %NULL when there's no match.
*/
GLoadableIcon *
calls_best_match_get_avatar (CallsBestMatch *self)
{