1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-05 10:39:27 +02:00

Remove doxygen warnings.

This commit is contained in:
B. Petersen 2017-11-14 12:21:51 +01:00
parent 56176199f6
commit f9bea17912
58 changed files with 412 additions and 359 deletions

View file

@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Delta Chat Core C-Library: mrchat_t Struct Reference</title>
<title>Delta Chat Core C-API: mrchat_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@ -24,7 +24,7 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Delta Chat Core C-Library
<div id="projectname">Delta Chat Core C-API
</div>
</td>
</tr>
@ -100,20 +100,20 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9">mrchat_unref</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a chat object. <a href="#a3b1befb4542c1bad915f2175c7c2a2b9">More...</a><br /></td></tr>
<tr class="separator:a3b1befb4542c1bad915f2175c7c2a2b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0d39be9ac9885810d8765053cfb81eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#af0d39be9ac9885810d8765053cfb81eb">mrchat_empty</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *ths)</td></tr>
<tr class="memdesc:af0d39be9ac9885810d8765053cfb81eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty a chat object. <a href="#af0d39be9ac9885810d8765053cfb81eb">More...</a><br /></td></tr>
<tr class="separator:af0d39be9ac9885810d8765053cfb81eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5c507c3944e38afe7584d59d9ece3cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#ae5c507c3944e38afe7584d59d9ece3cc">mrchat_empty</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:ae5c507c3944e38afe7584d59d9ece3cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty a chat object. <a href="#ae5c507c3944e38afe7584d59d9ece3cc">More...</a><br /></td></tr>
<tr class="separator:ae5c507c3944e38afe7584d59d9ece3cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08">mrchat_get_subtitle</a> (<a class="el" href="structmrchat__t.html">mrchat_t</a> *chat)</td></tr>
<tr class="memdesc:ae1e9920618c9f6cb8ad66d5bb6962a08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a subtitle for a chat. <a href="#ae1e9920618c9f6cb8ad66d5bb6962a08">More...</a><br /></td></tr>
<tr class="separator:ae1e9920618c9f6cb8ad66d5bb6962a08"><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>
<tr class="memitem:a1591431716413350eaffce0b588e4911"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1591431716413350eaffce0b588e4911"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_id</b></td></tr>
<tr class="memitem:a1591431716413350eaffce0b588e4911"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a1591431716413350eaffce0b588e4911">m_id</a></td></tr>
<tr class="memdesc:a1591431716413350eaffce0b588e4911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chat ID under which this object is available in the database. <a href="#a1591431716413350eaffce0b588e4911">More...</a><br /></td></tr>
<tr class="separator:a1591431716413350eaffce0b588e4911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a568c4e6fb9633ffe9a76428db16e0201"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a568c4e6fb9633ffe9a76428db16e0201"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>m_type</b></td></tr>
<tr class="memitem:a568c4e6fb9633ffe9a76428db16e0201"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#a568c4e6fb9633ffe9a76428db16e0201">m_type</a></td></tr>
<tr class="memdesc:a568c4e6fb9633ffe9a76428db16e0201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chat type, one of the MR_CHAT_TYPE_* constants. <a href="#a568c4e6fb9633ffe9a76428db16e0201">More...</a><br /></td></tr>
<tr class="separator:a568c4e6fb9633ffe9a76428db16e0201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbd344d8d361a1a4d14bfc9b5dc57140"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbd344d8d361a1a4d14bfc9b5dc57140"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140">m_name</a></td></tr>
@ -143,7 +143,7 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<div class="textblock"><p>An object representing a single chat in memory. </p>
<p>Chat objects are created using eg. <a class="el" href="structmrmailbox__t.html#ad106b9c23b3a559b524a37bb5504e096" title="Get a chat object of type mrchat_t by a chat_id. ">mrmailbox_get_chat()</a> and are not updated on database changes; if you want an update, you have to recreate the object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af0d39be9ac9885810d8765053cfb81eb"></a>
<a class="anchor" id="ae5c507c3944e38afe7584d59d9ece3cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@ -151,7 +151,7 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<td class="memname">void mrchat_empty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrchat__t.html">mrchat_t</a> *&#160;</td>
<td class="paramname"><em>ths</em></td><td>)</td>
<td class="paramname"><em>chat</em></td><td>)</td>
<td></td>
</tr>
</table>
@ -233,6 +233,34 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<p>1=chat archived, this state should always be shown the UI, eg. </p>
<p>the search will also return archived chats </p>
</div>
</div>
<a class="anchor" id="a1591431716413350eaffce0b588e4911"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t mrchat_t::m_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chat ID under which this object is available in the database. </p>
</div>
</div>
<a class="anchor" id="a568c4e6fb9633ffe9a76428db16e0201"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrchat_t::m_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chat type, one of the MR_CHAT_TYPE_* constants. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
@ -242,7 +270,7 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Nov 14 2017 11:55:36 for Delta Chat Core C-Library by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Tue Nov 14 2017 12:20:57 for Delta Chat Core C-API by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>