Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Dimon4eg
Dimon4eg committed Jan 16, 2021
1 parent 892f60e commit 0823d42
Show file tree
Hide file tree
Showing 403 changed files with 1,012 additions and 981 deletions.
2 changes: 1 addition & 1 deletion docs/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "Nakama C++ Client SDK"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 2.4.0
PROJECT_NUMBER = 2.4.1

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_client_factory_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_client_factory_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_account_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_n_account_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down Expand Up @@ -135,7 +135,7 @@
<div class="ttc" id="astruct_n_account_html_aee834e4317f33e0708dfe893ff772faa"><div class="ttname"><a href="struct_n_account.html#aee834e4317f33e0708dfe893ff772faa">NAccount::email</a></div><div class="ttdeci">std::string email</div><div class="ttdoc">The email address of the user.</div><div class="ttdef"><b>Definition:</b> NAccount.h:31</div></div>
<div class="ttc" id="a_n_user_8h_html"><div class="ttname"><a href="_n_user_8h.html">NUser.h</a></div></div>
<div class="ttc" id="a_n_types_8h_html_a12d69320d3aae350a8e291395a688875"><div class="ttname"><a href="_n_types_8h.html#a12d69320d3aae350a8e291395a688875">NAKAMA_NAMESPACE_END</a></div><div class="ttdeci">#define NAKAMA_NAMESPACE_END</div><div class="ttdef"><b>Definition:</b> NTypes.h:29</div></div>
<div class="ttc" id="a_n_types_8h_html_ab202da6d690ddb6520ea2ab2644dd82f"><div class="ttname"><a href="_n_types_8h.html#ab202da6d690ddb6520ea2ab2644dd82f">NTimestamp</a></div><div class="ttdeci">uint64_t NTimestamp</div><div class="ttdef"><b>Definition:</b> NTypes.h:53</div></div>
<div class="ttc" id="a_n_types_8h_html_ab202da6d690ddb6520ea2ab2644dd82f"><div class="ttname"><a href="_n_types_8h.html#ab202da6d690ddb6520ea2ab2644dd82f">NTimestamp</a></div><div class="ttdeci">uint64_t NTimestamp</div><div class="ttdef"><b>Definition:</b> NTypes.h:54</div></div>
<div class="ttc" id="astruct_n_user_html"><div class="ttname"><a href="struct_n_user.html">NUser</a></div><div class="ttdoc">A user in the server.</div><div class="ttdef"><b>Definition:</b> NUser.h:26</div></div>
<div class="ttc" id="astruct_n_account_html_ad2171d359b1048e13e34bb1494c01f62"><div class="ttname"><a href="struct_n_account.html#ad2171d359b1048e13e34bb1494c01f62">NAccount::customId</a></div><div class="ttdeci">std::string customId</div><div class="ttdoc">The custom id in the user's account.</div><div class="ttdef"><b>Definition:</b> NAccount.h:33</div></div>
<div class="ttc" id="astruct_n_account_html_ab7478cf4f30df7791f9e5f80be7670e2"><div class="ttname"><a href="struct_n_account.html#ab7478cf4f30df7791f9e5f80be7670e2">NAccount::user</a></div><div class="ttdeci">NUser user</div><div class="ttdoc">The user object.</div><div class="ttdef"><b>Definition:</b> NAccount.h:29</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_account_device_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_n_account_device_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down Expand Up @@ -119,7 +119,7 @@
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="a_n_types_8h_html_a43b64873d86a21be893013ac5ad17ceb"><div class="ttname"><a href="_n_types_8h.html#a43b64873d86a21be893013ac5ad17ceb">NAKAMA_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define NAKAMA_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition:</b> NTypes.h:28</div></div>
<div class="ttc" id="a_n_types_8h_html_aa069ec2d8a14f7faefc9518c352701ee"><div class="ttname"><a href="_n_types_8h.html#aa069ec2d8a14f7faefc9518c352701ee">NStringMap</a></div><div class="ttdeci">std::map&lt; std::string, std::string &gt; NStringMap</div><div class="ttdef"><b>Definition:</b> NTypes.h:58</div></div>
<div class="ttc" id="a_n_types_8h_html_aa069ec2d8a14f7faefc9518c352701ee"><div class="ttname"><a href="_n_types_8h.html#aa069ec2d8a14f7faefc9518c352701ee">NStringMap</a></div><div class="ttdeci">std::map&lt; std::string, std::string &gt; NStringMap</div><div class="ttdef"><b>Definition:</b> NTypes.h:59</div></div>
<div class="ttc" id="astruct_n_account_device_html"><div class="ttname"><a href="struct_n_account_device.html">NAccountDevice</a></div><div class="ttdoc">Used with authenticate/link/unlink and user.</div><div class="ttdef"><b>Definition:</b> NAccountDevice.h:24</div></div>
<div class="ttc" id="a_n_types_8h_html_a12d69320d3aae350a8e291395a688875"><div class="ttname"><a href="_n_types_8h.html#a12d69320d3aae350a8e291395a688875">NAKAMA_NAMESPACE_END</a></div><div class="ttdeci">#define NAKAMA_NAMESPACE_END</div><div class="ttdef"><b>Definition:</b> NTypes.h:29</div></div>
<div class="ttc" id="astruct_n_account_device_html_a8adfdba59acff8af18b712838e69cd54"><div class="ttname"><a href="struct_n_account_device.html#a8adfdba59acff8af18b712838e69cd54">NAccountDevice::vars</a></div><div class="ttdeci">NStringMap vars</div><div class="ttdoc">Extra information that will be bundled in the session token.</div><div class="ttdef"><b>Definition:</b> NAccountDevice.h:26</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_message_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_n_channel_message_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down Expand Up @@ -137,7 +137,7 @@
<div class="ttc" id="astruct_n_channel_message_html_ab9d80fc1f01ba8a74fd6c50723f9ae2d"><div class="ttname"><a href="struct_n_channel_message.html#ab9d80fc1f01ba8a74fd6c50723f9ae2d">NChannelMessage::messageId</a></div><div class="ttdeci">std::string messageId</div><div class="ttdoc">The unique ID of this message.</div><div class="ttdef"><b>Definition:</b> NChannelMessage.h:27</div></div>
<div class="ttc" id="astruct_n_channel_message_html_a34837f8f72bbd37d3421b6bcc22d6d81"><div class="ttname"><a href="struct_n_channel_message.html#a34837f8f72bbd37d3421b6bcc22d6d81">NChannelMessage::senderId</a></div><div class="ttdeci">std::string senderId</div><div class="ttdoc">Message sender, usually a user ID.</div><div class="ttdef"><b>Definition:</b> NChannelMessage.h:29</div></div>
<div class="ttc" id="a_n_types_8h_html_a12d69320d3aae350a8e291395a688875"><div class="ttname"><a href="_n_types_8h.html#a12d69320d3aae350a8e291395a688875">NAKAMA_NAMESPACE_END</a></div><div class="ttdeci">#define NAKAMA_NAMESPACE_END</div><div class="ttdef"><b>Definition:</b> NTypes.h:29</div></div>
<div class="ttc" id="a_n_types_8h_html_ab202da6d690ddb6520ea2ab2644dd82f"><div class="ttname"><a href="_n_types_8h.html#ab202da6d690ddb6520ea2ab2644dd82f">NTimestamp</a></div><div class="ttdeci">uint64_t NTimestamp</div><div class="ttdef"><b>Definition:</b> NTypes.h:53</div></div>
<div class="ttc" id="a_n_types_8h_html_ab202da6d690ddb6520ea2ab2644dd82f"><div class="ttname"><a href="_n_types_8h.html#ab202da6d690ddb6520ea2ab2644dd82f">NTimestamp</a></div><div class="ttdeci">uint64_t NTimestamp</div><div class="ttdef"><b>Definition:</b> NTypes.h:54</div></div>
<div class="ttc" id="a_n_export_8h_html_a538cb4d125d8843785ff47eff3de38e0"><div class="ttname"><a href="_n_export_8h.html#a538cb4d125d8843785ff47eff3de38e0">NAKAMA_API</a></div><div class="ttdeci">#define NAKAMA_API</div><div class="ttdef"><b>Definition:</b> NExport.h:40</div></div>
<div class="ttc" id="astruct_n_channel_message_html_a89b555a8c3f68daf627c133ddc2ca787"><div class="ttname"><a href="struct_n_channel_message.html#a89b555a8c3f68daf627c133ddc2ca787">NChannelMessage::content</a></div><div class="ttdeci">std::string content</div><div class="ttdoc">The content payload.</div><div class="ttdef"><b>Definition:</b> NChannelMessage.h:31</div></div>
<div class="ttc" id="astruct_n_channel_message_html_af06416dfe777128f18ee22751396373e"><div class="ttname"><a href="struct_n_channel_message.html#af06416dfe777128f18ee22751396373e">NChannelMessage::username</a></div><div class="ttdeci">std::string username</div><div class="ttdoc">The username of the message sender, if any.</div><div class="ttdef"><b>Definition:</b> NChannelMessage.h:30</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_message_ack_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_n_channel_message_ack_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down Expand Up @@ -135,7 +135,7 @@
<div class="ttc" id="astruct_n_channel_message_ack_html_a24cc5c73601330adcfbfcde7d15dfa6d"><div class="ttname"><a href="struct_n_channel_message_ack.html#a24cc5c73601330adcfbfcde7d15dfa6d">NChannelMessageAck::groupId</a></div><div class="ttdeci">std::string groupId</div><div class="ttdoc">The ID of the group, or an empty string if this message was not sent through a group channel.</div><div class="ttdef"><b>Definition:</b> NChannelMessageAck.h:35</div></div>
<div class="ttc" id="astruct_n_channel_message_ack_html_a96a539d60af3bb0c8f20e746b8863591"><div class="ttname"><a href="struct_n_channel_message_ack.html#a96a539d60af3bb0c8f20e746b8863591">NChannelMessageAck::userIdOne</a></div><div class="ttdeci">std::string userIdOne</div><div class="ttdoc">The ID of the first DM user, or an empty string if this message was not sent through a DM chat.</div><div class="ttdef"><b>Definition:</b> NChannelMessageAck.h:36</div></div>
<div class="ttc" id="a_n_types_8h_html_a12d69320d3aae350a8e291395a688875"><div class="ttname"><a href="_n_types_8h.html#a12d69320d3aae350a8e291395a688875">NAKAMA_NAMESPACE_END</a></div><div class="ttdeci">#define NAKAMA_NAMESPACE_END</div><div class="ttdef"><b>Definition:</b> NTypes.h:29</div></div>
<div class="ttc" id="a_n_types_8h_html_ab202da6d690ddb6520ea2ab2644dd82f"><div class="ttname"><a href="_n_types_8h.html#ab202da6d690ddb6520ea2ab2644dd82f">NTimestamp</a></div><div class="ttdeci">uint64_t NTimestamp</div><div class="ttdef"><b>Definition:</b> NTypes.h:53</div></div>
<div class="ttc" id="a_n_types_8h_html_ab202da6d690ddb6520ea2ab2644dd82f"><div class="ttname"><a href="_n_types_8h.html#ab202da6d690ddb6520ea2ab2644dd82f">NTimestamp</a></div><div class="ttdeci">uint64_t NTimestamp</div><div class="ttdef"><b>Definition:</b> NTypes.h:54</div></div>
<div class="ttc" id="a_n_export_8h_html_a538cb4d125d8843785ff47eff3de38e0"><div class="ttname"><a href="_n_export_8h.html#a538cb4d125d8843785ff47eff3de38e0">NAKAMA_API</a></div><div class="ttdeci">#define NAKAMA_API</div><div class="ttdef"><b>Definition:</b> NExport.h:40</div></div>
<div class="ttc" id="astruct_n_channel_message_ack_html_ada9ea8acef579f2ff5839afa4e40944b"><div class="ttname"><a href="struct_n_channel_message_ack.html#ada9ea8acef579f2ff5839afa4e40944b">NChannelMessageAck::userIdTwo</a></div><div class="ttdeci">std::string userIdTwo</div><div class="ttdoc">The ID of the second DM user, or an empty string if this message was not sent through a DM chat.</div><div class="ttdef"><b>Definition:</b> NChannelMessageAck.h:37</div></div>
<div class="ttc" id="astruct_n_channel_message_ack_html_a947c501bb369191053a629283ade3d19"><div class="ttname"><a href="struct_n_channel_message_ack.html#a947c501bb369191053a629283ade3d19">NChannelMessageAck::roomName</a></div><div class="ttdeci">std::string roomName</div><div class="ttdoc">The name of the chat room, or an empty string if this message was not sent through a chat room.</div><div class="ttdef"><b>Definition:</b> NChannelMessageAck.h:34</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_message_list_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_message_list_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_presence_event_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_channel_presence_event_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_n_client_interface_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="nakama_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nakama C++ Client SDK
&#160;<span id="projectnumber">2.4.0</span>
&#160;<span id="projectnumber">2.4.1</span>
</div>
<div id="projectbrief">Client for Nakama Server</div>
</td>
Expand Down
Loading

0 comments on commit 0823d42

Please sign in to comment.