yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-06 03:50:08 +02:00
Code Issues Releases Wiki Activity

comment

Browse source
This commit is contained in:
B. Petersen 2018-07-12 18:50:09 +02:00
parent 31044aa92b
commit 134533e839
2 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/dc_contact.c
View file

@ -137,11 +137,10 @@ char* dc_contact_get_addr(const dc_contact_t* contact)
/**
* Get name. This is the name as defined the the contact himself or
* Get name. This is the name as defined by the contact himself or
* modified by the user. 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 must not be spreaded via mail (To:, CC: ...) as it as it may be sth. like "Daddy".
* To get a fine name to display in lists etc., use dc_contact_get_display_name() or dc_contact_get_name_n_addr().
*
* @memberof dc_contact_t
@ -159,10 +158,10 @@ char* dc_contact_get_name(const dc_contact_t* contact)
/**
* Get display name. This is the name as defined the the contact himself,
* Get display name. This is the name as defined by the contact himself,
* modified by the user or, if both are unset, the email address.
*
* This name is typically used in lists and must not be speaded via mail (To:, CC: ...).
* This name is typically used in lists.
* To get the name editable in a formular, use dc_contact_get_name().
*
* @memberof dc_contact_t
@ -192,8 +191,6 @@ char* dc_contact_get_display_name(const dc_contact_t* contact)
* The summary is typically used when asking the user something about the contact.
* The attached email address makes the question unique, eg. "Chat with Alan Miller (am@uniquedomain.com)?"
*
* The summary must not be spreaded via mail (To:, CC: ...) as it as it may contain sth. like "Daddy".
*
* @memberof dc_contact_t
* @param contact The contact object.
* @return Summary string, must be free()'d. Never returns NULL.

10
src/deltachat.h
View file

@ -509,8 +509,14 @@ void dc_msg_latefiling_mediasize (dc_msg_t*, int width, int height,
* @class dc_contact_t
*
* An object representing a single contact in memory.
* The contact object is not updated. If you want an update, you have to recreate
* the object.
* The contact object is not updated. If you want an update, you have to recreate the object.
*
* The library makes sure only to use names _authorized_ by the contact in `To:` or `Cc:`.
* Given-names as "Daddy" or "Honey" are not used there.
* For this purpose, internally, two names are tracked - autorized-name and given-name.
* By default, these names are equal, but functions working with contact names
* (eg. dc_contact_get_name(), dc_contact_get_display_name(), dc_contact_get_name_n_addr(),
* dc_contact_get_first_name(), dc_create_contact() or dc_add_address_book()) only affect the given-name.
*/
typedef struct _dc_contact dc_contact_t;