update docs for dc_contact_get_name()

This commit is contained in:
B. Petersen
2021-02-09 16:35:11 +01:00
committed by bjoern
parent 3f9242a610
commit c41f1b42df
2 changed files with 6 additions and 4 deletions

View File

@@ -4015,8 +4015,10 @@ char* dc_contact_get_addr (const dc_contact_t* contact);
/** /**
* Get the contact name. This is the name as defined by the contact himself or * Get the edited contact name.
* modified by the user. May be an empty string. * This is the name as given or modified by the local user using dc_create_contact().
* If there is no such name for the contact, an empty string is returned.
* The function does not return the contact name as received from the network.
* *
* This name is typically used in a form where the user can edit the name of a contact. * This name is typically used in a form where the user can edit the name of a contact.
* To get a fine name to display in lists etc., use dc_contact_get_display_name() or dc_contact_get_name_n_addr(). * To get a fine name to display in lists etc., use dc_contact_get_display_name() or dc_contact_get_name_n_addr().

View File

@@ -867,8 +867,8 @@ impl Contact {
&self.authname &self.authname
} }
/// Get the contact name. This is the name as defined by the contact himself or /// Get the contact name. This is the name as modified by the local user.
/// modified by the user. May be an empty string. /// May be an empty string.
/// ///
/// This name is typically used in a form where the user can edit the name of a contact. /// This name is typically used in a form where the user can edit the name of a contact.
/// To get a fine name to display in lists etc., use `Contact::get_display_name` or `Contact::get_name_n_addr`. /// To get a fine name to display in lists etc., use `Contact::get_display_name` or `Contact::get_name_n_addr`.