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

Doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-20 09:59:50 +01:00
parent 658ceb656d
commit 65b4d2d515
6 changed files with 17 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/html/mrchat_8h_source.html
View file

@ -97,7 +97,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="structmrchat__t_html_ad2792ee7df778521de61087bc79795a7"><div class="ttname"><a href="structmrchat__t.html#ad2792ee7df778521de61087bc79795a7">mrchat_t::m_param</a></div><div class="ttdeci">mrparam_t * m_param</div><div class="ttdoc">Additional parameters for the chat. </div><div class="ttdef"><b>Definition:</b> mrchat.h:133</div></div>
<div class="ttc" id="structmrchat__t_html_a5b28b343ceb290d4a613d0e5a7d528bc"><div class="ttname"><a href="structmrchat__t.html#a5b28b343ceb290d4a613d0e5a7d528bc">mrchat_t::m_archived</a></div><div class="ttdeci">int m_archived</div><div class="ttdoc">Flag for the archived state. </div><div class="ttdef"><b>Definition:</b> mrchat.h:126</div></div>
<div class="ttc" id="structmrchat__t_html_abbd344d8d361a1a4d14bfc9b5dc57140"><div class="ttname"><a href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">mrchat_t::m_name</a></div><div class="ttdeci">char * m_name</div><div class="ttdoc">Name of the chat. </div><div class="ttdef"><b>Definition:</b> mrchat.h:86</div></div>
<div class="ttc" id="structmrparam__t_html"><div class="ttname"><a href="structmrparam__t.html">mrparam_t</a></div><div class="ttdoc">An object for handling key=value parameter lists. </div><div class="ttdef"><b>Definition:</b> mrparam.h:36</div></div>
<div class="ttc" id="structmrparam__t_html"><div class="ttname"><a href="structmrparam__t.html">mrparam_t</a></div><div class="ttdoc">An object for handling key=value parameter lists. </div><div class="ttdef"><b>Definition:</b> mrparam.h:44</div></div>
<div class="ttc" id="structmrchat__t_html_a565101f53278f5ab1ff58317ffc9555c"><div class="ttname"><a href="structmrchat__t.html#a565101f53278f5ab1ff58317ffc9555c">mrchat_t::m_draft_timestamp</a></div><div class="ttdeci">time_t m_draft_timestamp</div><div class="ttdoc">Timestamp of the draft. </div><div class="ttdef"><b>Definition:</b> mrchat.h:96</div></div>
<div class="ttc" id="structmrchat__t_html_a1591431716413350eaffce0b588e4911"><div class="ttname"><a href="structmrchat__t.html#a1591431716413350eaffce0b588e4911">mrchat_t::m_id</a></div><div class="ttdeci">uint32_t m_id</div><div class="ttdoc">Chat ID under which the chat is filed in the database. </div><div class="ttdef"><b>Definition:</b> mrchat.h:51</div></div>
<div class="ttc" id="structmrchat__t_html"><div class="ttname"><a href="structmrchat__t.html">mrchat_t</a></div><div class="ttdoc">An object representing a single chat in memory. </div><div class="ttdef"><b>Definition:</b> mrchat.h:39</div></div>

2
docs/html/mrjob_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrmimeparser_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrmsg_8h_source.html
View file

@ -105,7 +105,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="structmrmsg__t_html_a299981cb89b25ebaaedf7a8486a86ee6"><div class="ttname"><a href="structmrmsg__t.html#a299981cb89b25ebaaedf7a8486a86ee6">mrmsg_t::m_from_id</a></div><div class="ttdeci">uint32_t m_from_id</div><div class="ttdoc">Contact ID of the sender. </div><div class="ttdef"><b>Definition:</b> mrmsg.h:62</div></div>
<div class="ttc" id="structmrmsg__t_html_a0570bbfc3add48dafb0ae70390b47adb"><div class="ttname"><a href="structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb">mrmsg_t::m_starred</a></div><div class="ttdeci">int m_starred</div><div class="ttdoc">Starred-state of the message. </div><div class="ttdef"><b>Definition:</b> mrmsg.h:140</div></div>
<div class="ttc" id="structmrmsg__t_html_ae940aa79a261e1a427b12baefbee2d23"><div class="ttname"><a href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_t::mrmsg_set_text</a></div><div class="ttdeci">void mrmsg_set_text(mrmsg_t *msg, const char *text)</div><div class="ttdoc">Set the text of a message object. </div><div class="ttdef"><b>Definition:</b> mrmsg.c:174</div></div>
<div class="ttc" id="structmrparam__t_html"><div class="ttname"><a href="structmrparam__t.html">mrparam_t</a></div><div class="ttdoc">An object for handling key=value parameter lists. </div><div class="ttdef"><b>Definition:</b> mrparam.h:36</div></div>
<div class="ttc" id="structmrparam__t_html"><div class="ttname"><a href="structmrparam__t.html">mrparam_t</a></div><div class="ttdoc">An object for handling key=value parameter lists. </div><div class="ttdef"><b>Definition:</b> mrparam.h:44</div></div>
<div class="ttc" id="structmrmsg__t_html_a2c31ec5b23e35fbe3ae3896eece09453"><div class="ttname"><a href="structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453">mrmsg_t::m_param</a></div><div class="ttdeci">mrparam_t * m_param</div><div class="ttdoc">Additional paramter for the message. </div><div class="ttdef"><b>Definition:</b> mrmsg.h:139</div></div>
<div class="ttc" id="structmrmsg__t_html_ae54dcd4036371597d7f8bbd75303527a"><div class="ttname"><a href="structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a">mrmsg_t::m_text</a></div><div class="ttdeci">char * m_text</div><div class="ttdoc">message text or NULL if unset </div><div class="ttdef"><b>Definition:</b> mrmsg.h:138</div></div>
<div class="ttc" id="structmrmsg__t_html_aa33212e41efff643aa7290753f3d9b02"><div class="ttname"><a href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_t::mrmsg_unref</a></div><div class="ttdeci">void mrmsg_unref(mrmsg_t *msg)</div><div class="ttdoc">Free an mrmsg_t object created eg. </div><div class="ttdef"><b>Definition:</b> mrmsg.c:68</div></div>

6
docs/html/mrparam_8h_source.html
View file

File diff suppressed because one or more lines are too long

13
docs/html/structmrparam__t.html
View file

@ -97,7 +97,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a88397aa66e74bcdc61c8376c8e9a761b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#a88397aa66e74bcdc61c8376c8e9a761b">mrparam_empty</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param)</td></tr>
<tr class="memdesc:a88397aa66e74bcdc61c8376c8e9a761b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete all parameters. <a href="#a88397aa66e74bcdc61c8376c8e9a761b">More...</a><br /></td></tr>
<tr class="memdesc:a88397aa66e74bcdc61c8376c8e9a761b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete all parameters in the object. <a href="#a88397aa66e74bcdc61c8376c8e9a761b">More...</a><br /></td></tr>
<tr class="separator:a88397aa66e74bcdc61c8376c8e9a761b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a9d3768d128dce0088b089f66fafb68"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#a0a9d3768d128dce0088b089f66fafb68">mrparam_exists</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param, int key)</td></tr>
<tr class="memdesc:a0a9d3768d128dce0088b089f66fafb68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a parameter exists. <a href="#a0a9d3768d128dce0088b089f66fafb68">More...</a><br /></td></tr>
@ -117,7 +117,14 @@ Public Member Functions</h2></td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An object for handling key=value parameter lists. </p>
<p>The parameter object is used eg. by <a class="el" href="structmrchat__t.html" title="An object representing a single chat in memory. ">mrchat_t</a> or <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a>. To access the single parameters use the setter and getter functions with an MRP_* constant. </p>
<p>The parameter object is used eg. by <a class="el" href="structmrchat__t.html" title="An object representing a single chat in memory. ">mrchat_t</a> or <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a>. To access the single parameters use the setter and getter functions with an MRP_* constant, eg.</p>
<ul>
<li>MRP_FILE - the file associated with a message, not for text messages</li>
<li>MRP_WIDTH - the width of an image or video</li>
<li>MRP_HEIGHT - the height of an image or video</li>
<li>MRP_DURATION - the duration of an video or audio</li>
</ul>
<p>However, for most functions, it is easier to use more conctrete functions as mrmsg_get_file(). </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a88397aa66e74bcdc61c8376c8e9a761b"></a>
<div class="memitem">
@ -133,7 +140,7 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Delete all parameters. </p>
<p>Delete all parameters in the object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>Parameter object to modify.</td></tr>