Skip to content

Commit

Permalink
Updated documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
@redboltz
redboltz committed Jun 24, 2024
1 parent d7ca855 commit 102f878
Show file tree
Hide file tree
Showing 407 changed files with 933 additions and 934 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
:last-update-label!:

= History
== 7.0.1
== 8.0.0
=== breaking changes
* `client` becomes `shared_ptr` similar as `endpoint`. #315
** To create `client` instance, `client<...>::create(args)` similar as `endpoint`.
** This is required to keep client's lifetime during async operation is working.
** `client` and `endpoint` are consistent interface now.
=== other updates
* Move endpoint definition (using) to endpoint_fwd.hpp #311, #312
* install `*.ipp` files along with other header files #309
* Refined documents. #308

== 7.0.0
Expand Down
4 changes: 2 additions & 2 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# http://www.boost.org/LICENSE_1_0.txt)

cmake_minimum_required (VERSION 3.13.0)
project(async_mqtt_iface VERSION 7.0.1)
project(async_mqtt_iface VERSION 8.0.0)

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
Expand Down Expand Up @@ -136,7 +136,7 @@ if(DOXYGEN_FOUND)
COMMAND ${CMAKE_COMMAND} -E echo "FILE_PATTERNS = *.hpp" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMAND ${CMAKE_COMMAND} -E echo "OUTPUT_DIRECTORY = doc" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NAME = async_mqtt" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NUMBER = 7.0.1" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMAND ${CMAKE_COMMAND} -E echo "PROJECT_NUMBER = 8.0.0" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMAND ${CMAKE_COMMAND} -E echo "RECURSIVE = YES" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMAND ${CMAKE_COMMAND} -E echo "PREDEFINED = GENERATING_DOCUMENTATION ASYNC_MQTT_USE_TLS ASYNC_MQTT_USE_WS ASYNC_MQTT_USE_LOG" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
COMMAND ${CMAKE_COMMAND} -E echo "INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/include/async_mqtt" >> ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Asynchronous MQTT communication library.

Version 7.0.1 [![Actions Status](https://github.com/redboltz/async_mqtt/workflows/CI/badge.svg)](https://github.com/redboltz/async_mqtt/actions)[![codecov](https://codecov.io/gh/redboltz/async_mqtt/branch/main/graph/badge.svg)](https://codecov.io/gh/redboltz/async_mqtt)
Version 8.0.0 [![Actions Status](https://github.com/redboltz/async_mqtt/workflows/CI/badge.svg)](https://github.com/redboltz/async_mqtt/actions)[![codecov](https://codecov.io/gh/redboltz/async_mqtt/branch/main/graph/badge.svg)](https://codecov.io/gh/redboltz/async_mqtt)

This is Boost.Asio oriented asynchronous MQTT communication library. You can use async_mqtt to develop not only your MQTT client application but also your server (e.g. broker).
Based on https://github.com/redboltz/mqtt_cpp experience, there are many improvements. See overview.
Expand Down
31 changes: 26 additions & 5 deletions doc/CHANGELOG.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.22">
<meta name="author" content="== 7.0.1">
<meta name="author" content="== 8.0.0">
<title>History</title>
<style>
/*! Copyright (C) 2019, TomTom (http://tomtom.com).
Expand Down Expand Up @@ -63,9 +63,8 @@
<div id="header">
<h1>History</h1>
<div class="details">
<span id="author" class="author">== 7.0.1</span><br>
<span id="revnumber">version 311,</span>
<span id="revdate">#312</span>
<span id="author" class="author">== 8.0.0</span><br>
<span id="revdate">=== breaking changes</span>
</div>
</div>
<div id="content">
Expand All @@ -74,6 +73,29 @@ <h1>History</h1>
<div class="ulist">
<ul>
<li>
<p><code>client</code> becomes <code>shared_ptr</code> similar as <code>endpoint</code>. #315</p>
<div class="ulist">
<ul>
<li>
<p>To create <code>client</code> instance, <code>client&lt;&#8230;&#8203;&gt;::create(args)</code> similar as <code>endpoint</code>.</p>
</li>
<li>
<p>This is required to keep client&#8217;s lifetime during async operation is working.</p>
</li>
<li>
<p><code>client</code> and <code>endpoint</code> are consistent interface now.
=== other updates</p>
</li>
</ul>
</div>
</li>
<li>
<p>Move endpoint definition (using) to endpoint_fwd.hpp #311, #312</p>
</li>
<li>
<p>install <code>*.ipp</code> files along with other header files #309</p>
</li>
<li>
<p>Refined documents. #308</p>
</li>
</ul>
Expand Down Expand Up @@ -853,7 +875,6 @@ <h2 id="_1_0_0">1.0.0</h2>
</div>
<div id="footer">
<div id="footer-text">
Version 311<br>
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/all_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/buffer_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/buffer__to__packet__variant_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1basic__endpoint-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1basic__endpoint.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1basic__packet__variant-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1basic__packet__variant.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1basic__store__packet__variant-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1basic__store__packet__variant.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1buffer-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/classasync__mqtt_1_1buffer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">async_mqtt<span id="projectnumber">&#160;7.0.1</span>
<div id="projectname">async_mqtt<span id="projectnumber">&#160;8.0.0</span>
</div>
</td>
</tr>
Expand Down
Loading

0 comments on commit 102f878

Please sign in to comment.