yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-04 18:29:19 +02:00
Code Issues Releases Wiki Activity

doxygen

Browse source
This commit is contained in:
B. Petersen 2017-12-19 15:02:30 +01:00
parent 21bc14c304
commit a5ffcc781a
19 changed files with 177 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/html/functions.html
View file

@ -156,6 +156,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrchat_get_type()
: <a class="el" href="structmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503">mrchat_t</a>
</li>
<li>mrchat_is_self_talk()
: <a class="el" href="structmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca">mrchat_t</a>
</li>
<li>mrchat_is_unpromoted()
: <a class="el" href="structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_t</a>
</li>

3
docs/html/functions_func.html
View file

@ -124,6 +124,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrchat_get_type()
: <a class="el" href="structmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503">mrchat_t</a>
</li>
<li>mrchat_is_self_talk()
: <a class="el" href="structmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca">mrchat_t</a>
</li>
<li>mrchat_is_unpromoted()
: <a class="el" href="structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_t</a>
</li>

8
docs/html/mrarray_8h_source.html
View file

File diff suppressed because one or more lines are too long

21
docs/html/mrchat_8h_source.html
View file

File diff suppressed because one or more lines are too long

12
docs/html/mrchatlist_8h_source.html
View file

File diff suppressed because one or more lines are too long

14
docs/html/mrcontact_8h_source.html
View file

File diff suppressed because one or more lines are too long

14
docs/html/mrlot_8h_source.html
View file

File diff suppressed because one or more lines are too long

130
docs/html/mrmailbox_8h_source.html
View file

File diff suppressed because one or more lines are too long

56
docs/html/mrmsg_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrparam_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrstock_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrtools_8h_source.html
View file

File diff suppressed because one or more lines are too long

1
docs/html/search/all_1.js
View file

@ -37,6 +37,7 @@ var searchData=
['mrchat_5fget_5fprofile_5fimage',['mrchat_get_profile_image',['../structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b',1,'mrchat_t']]],
['mrchat_5fget_5fsubtitle',['mrchat_get_subtitle',['../structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08',1,'mrchat_t']]],
['mrchat_5fget_5ftype',['mrchat_get_type',['../structmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503',1,'mrchat_t']]],
['mrchat_5fis_5fself_5ftalk',['mrchat_is_self_talk',['../structmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca',1,'mrchat_t']]],
['mrchat_5fis_5funpromoted',['mrchat_is_unpromoted',['../structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb',1,'mrchat_t']]],
['mrchat_5ft',['mrchat_t',['../structmrchat__t.html',1,'']]],
['mrchat_5funref',['mrchat_unref',['../structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9',1,'mrchat_t']]],

1
docs/html/search/functions_0.js
View file

@ -9,6 +9,7 @@ var searchData=
['mrchat_5fget_5fprofile_5fimage',['mrchat_get_profile_image',['../structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b',1,'mrchat_t']]],
['mrchat_5fget_5fsubtitle',['mrchat_get_subtitle',['../structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08',1,'mrchat_t']]],
['mrchat_5fget_5ftype',['mrchat_get_type',['../structmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503',1,'mrchat_t']]],
['mrchat_5fis_5fself_5ftalk',['mrchat_is_self_talk',['../structmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca',1,'mrchat_t']]],
['mrchat_5fis_5funpromoted',['mrchat_is_unpromoted',['../structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb',1,'mrchat_t']]],
['mrchat_5funref',['mrchat_unref',['../structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9',1,'mrchat_t']]],
['mrchatlist_5fget_5fchat_5fid',['mrchatlist_get_chat_id',['../structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5',1,'mrchatlist_t']]],

5
docs/html/structmrchat__t-members.html
View file

@ -95,8 +95,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b">mrchat_get_profile_image</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#a187ab591ec058f4e43c1ba205bbd7503">mrchat_get_type</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_is_unpromoted</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca">mrchat_is_self_talk</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_is_unpromoted</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a>(mrchat_t *chat)</td><td class="entry"><a class="el" href="structmrchat__t.html">mrchat_t</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>

31
docs/html/structmrchat__t.html
View file

@ -121,6 +121,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#af23f2fd022f9978f7eed5ed46f3d9fbb">mrchat_is_unpromoted</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a chat is still unpromoted. <a href="#af23f2fd022f9978f7eed5ed46f3d9fbb">More...</a><br /></td></tr>
<tr class="separator:af23f2fd022f9978f7eed5ed46f3d9fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a293685c189ab86d230dfe27a5a28c1ca"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a293685c189ab86d230dfe27a5a28c1ca">mrchat_is_self_talk</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a293685c189ab86d230dfe27a5a28c1ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a chat is a self talk. <a href="#a293685c189ab86d230dfe27a5a28c1ca">More...</a><br /></td></tr>
<tr class="separator:a293685c189ab86d230dfe27a5a28c1ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@ -174,7 +177,7 @@ Public Attributes</h2></td></tr>
<p>Get chat type. </p>
<p>Currently, there are two chat types:</p>
<ul>
<li>MR_CHAT_TYPE_NORMAL (100) - a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF (see <a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716" title="The contact ID. ">mrcontact_t::m_id</a>) is not added.</li>
<li>MR_CHAT_TYPE_NORMAL (100) - a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF (see <a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716" title="The contact ID. ">mrcontact_t::m_id</a>) is added <em>only</em> for a self talk.</li>
<li>MR_CHAT_TYPE_GROUP (120) - a group chat, chats_contacts conain all group members, incl. MR_CONTACT_ID_SELF</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
@ -351,6 +354,32 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1=chat is still unpromoted, no message was ever send to the chat, 0=chat is not unpromoted, messages were send and/or received </dd></dl>
</div>
</div>
<a class="anchor" id="a293685c189ab86d230dfe27a5a28c1ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_is_self_talk </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>chat</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a chat is a self talk. </p>
<p>Self talks are normal chats with the only contact MR_CONTACT_ID_SELF.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chat</td><td>The chat object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1=chat is self talk, 0=chat is no self talk </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>

3
docs/html/structmrmailbox__t.html
View file

@ -2168,6 +2168,7 @@ Public Attributes</h2></td></tr>
<p>Add a single contact. </p>
<p>We assume, the contact name, if any, is entered by the user and is used "as is" therefore, mr_normalize_name() is <em>not</em> called for the name.</p>
<p>To add a number of contacts, see <a class="el" href="structmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6" title="Add a number of contacts. ">mrmailbox_add_address_book()</a> which is much faster for adding a bunch of addresses.</p>
<p>May result in a <a class="el" href="mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f" title="Contact(s) created, renamed, blocked or deleted. ">MR_EVENT_CONTACTS_CHANGED</a> event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as created by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
@ -2331,6 +2332,7 @@ Public Attributes</h2></td></tr>
<p>Get a single contact object. </p>
<p>For a list, see eg. <a class="el" href="structmrmailbox__t.html#ae4ccc69ba8e8851a04f9b17b37e5f86a" title="Returns known and unblocked contacts. ">mrmailbox_get_known_contacts()</a>.</p>
<p>For contact MR_CONTACT_ID_SELF (1), the function returns the name MR_STR_SELF (typically "Me" in the selected language) and the email address defined by <a class="el" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad" title="Configure the mailbox. ">mrmailbox_set_config()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as created by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
@ -2486,6 +2488,7 @@ Public Attributes</h2></td></tr>
<p>Delete a contact. </p>
<p>The contact is deleted from the local device. It may happen that this is not possible as the contact is in used. In this case, the contact can be blocked.</p>
<p>May result in a <a class="el" href="mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f" title="Contact(s) created, renamed, blocked or deleted. ">MR_EVENT_CONTACTS_CHANGED</a> event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as created by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>

2
src/mrlot.h
View file

@ -35,7 +35,7 @@ extern "C" {
*/
typedef struct mrlot_t
{
uint32_t m_magic; /** @private */
uint32_t m_magic; /**< @private */
int m_text1_meaning; /**< The meaning of this value is defined by the creator of the object. 0 if not applicable. */
char* m_text1; /**< The meaning of this string is defined by the creator of the object. The string is freed with mrlot_unref(). NULL if not applicable. */
char* m_text2; /**< The meaning of this string is defined by the creator of the object. The string is freed with mrlot_unref(). NULL if not applicable. */

2
src/mrmsg.h
View file

@ -39,7 +39,7 @@ typedef struct sqlite3_stmt sqlite3_stmt;
*/
typedef struct mrmsg_t
{
uint32_t m_magic;
uint32_t m_magic; /**< @private */
/**
* Message ID. Never 0.