boostorg/mqtt5
1
0
Fork 1
mirror of https://github.com/boostorg/mqtt5.git synced 2025-10-04 12:50:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
62d7eb21b22eca01038989c6631e5403ccf18c67
mqtt5/doc/qbk/00_main.qbk

113 lines
5.1 KiB
Plaintext
Raw Normal View History

[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
[library async_mqtt5
[quickbook 1.7]
[copyright 2023 Mireo]
[id async_mqtt5]
[purpose MQTT C++ client library]
[license
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
[@http://www.boost.org/LICENSE_1_0.txt])
]
[authors [A,B,C]]
[category template]
[category generic]
]
[template nochunk[] [block '''<?dbhtml stop-chunking?>''']]
[template mdash[] '''&mdash; ''']
[template include_file[path][^<'''<ulink url="GITHUB_LINK">'''[path]'''</ulink>'''>]]
[template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
[template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
[template reflink2[id text][link async_mqtt5.ref.async_mqtt5__[id] [^[text]]]]
[template reflink[id][reflink2 [id] [id]]]
[template refmem[class mem][reflink2 [class].[mem] [class]::[mem]]]
[template refmemunq[class mem][reflink2 [class].[mem] [mem]]]
[template asioreflink[id term][@boost:/doc/html/boost_asio/reference/[id].html [^boost::asio::[term]]]]
[template beastreflink[id term][@boost:/libs/beast/doc/html/beast/ref/[id].html [^boost::beast::[term]]]]
[template beastconceptslink[id term][@boost:/libs/beast/doc/html/beast/concepts/[id].html [term]]]
[mqtt-client] reason codes & properties documented Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26113
2023-10-16 15:57:26 +02:00
[template mqttlink[id text][@https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc[id] [text]]]
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
[mqtt-client] reason codes & properties documented Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26113
2023-10-16 15:57:26 +02:00
[def __CompletionToken__ [@boost:/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.completion_tokens_and_handlers ['CompletionToken]]]
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
[def __ExecutionContext__ [reflink2 ExecutionContext ['ExecutionContext]]]
[def __StreamType__ [reflink2 StreamType ['StreamType]]]
[def __TlsContext__ [reflink2 TlsContext ['TlsContext]]]
[def __Boost__ [@https://www.boost.org/ Boost]]
[def __Asio__ [@boost:/libs/asio/index.html Boost.Asio]]
[def __Self__ [async_mqtt5]]
[mqtt-client] A lot of various document changes Summary: related to T12804 - property files are now lowercase and match code names - properties properly link to their pages - packet names do not automatically link anymore - TlsContext documented - types inside handler signatures properly link to their pages next up: better error code documentation Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26155
2023-10-18 12:16:05 +02:00
[/ MQTT ]
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
[def __MQTT__ [@https://mqtt.org/ MQTT]]
[mqtt-client] A lot of various document changes Summary: related to T12804 - property files are now lowercase and match code names - properties properly link to their pages - packet names do not automatically link anymore - TlsContext documented - types inside handler signatures properly link to their pages next up: better error code documentation Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26155
2023-10-18 12:16:05 +02:00
[mqtt-client] reason codes & properties documented Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26113
2023-10-16 15:57:26 +02:00
[def __UTF8_STRING_PAIR__ [mqttlink 3901013 `UTF-8 String Pair`]]
[def __PACKET_SIZE__ [mqttlink 3901024 `packet size`]]
[mqtt-client] A lot of various document changes Summary: related to T12804 - property files are now lowercase and match code names - properties properly link to their pages - packet names do not automatically link anymore - TlsContext documented - types inside handler signatures properly link to their pages next up: better error code documentation Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26155
2023-10-18 12:16:05 +02:00
[def __QOS__ [mqttlink 3901234 `QoS`]]
[def __SUBSCRIBE_OPTIONS__ [mqttlink 3901169 `Subscribe Options`]]
[def __CONNECT__ [mqttlink 3901033 `CONNECT`]]
[def __CONNACK__ [mqttlink 3901074 `CONNACK`]]
[def __PUBLISH__ [mqttlink 3901100 `PUBLISH`]]
[def __PUBACK__ [mqttlink 3901121 `PUBACK`]]
[def __PUBREC__ [mqttlink 3901131 `PUBREC`]]
[def __PUBREL__ [mqttlink 3901141 `PUBREL`]]
[def __PUBCOMP__ [mqttlink 3901151 `PUBCOMP`]]
[def __SUBSCRIBE__ [mqttlink 3901161 `SUBSCRIBE`]]
[def __SUBACK__ [mqttlink 3901171 `SUBACK`]]
[def __UNSUBSCRIBE__ [mqttlink 3901179 `UNSUBSCRIBE`]]
[def __UNSUBACK__ [mqttlink 3901187 `UNSUBACK`]]
[def __PINGREQ__ [mqttlink 3901195 `PINGREQ`]]
[def __PINGRESP__ [mqttlink 3901200 `PINGRESP`]]
[def __DISCONNECT__ [mqttlink 3901205 `DISCONNECT`]]
[def __AUTH__ [mqttlink 3901217 `AUTH`]]
[def __WILL_PROPS__ [reflink2 will_props async_mqtt5::will_props]]
[def __CONNECT_PROPS__ [reflink2 connect_props async_mqtt5::connect_props]]
[def __CONNACK_PROPS__ [reflink2 connack_props async_mqtt5::connack_props]]
[def __PUBLISH_PROPS__ [reflink2 publish_props async_mqtt5::publish_props]]
[def __PUBACK_PROPS__ [reflink2 puback_props async_mqtt5::puback_props]]
[def __PUBREC_PROPS__ [reflink2 pubrec_props async_mqtt5::pubrec_props]]
[def __PUBREL_PROPS__ [reflink2 pubrel_props async_mqtt5::pubrel_props]]
[def __PUBCOMP_PROPS__ [reflink2 pubcomp_props async_mqtt5::pubcomp_props]]
[def __SUBSCRIBE_PROPS__ [reflink2 subscribe_props async_mqtt5::subscribe_props]]
[def __SUBACK_PROPS__ [reflink2 suback_props async_mqtt5::suback_props]]
[def __UNSUBSCRIBE_PROPS__ [reflink2 unsubscribe_props async_mqtt5::unsubscribe_props]]
[def __UNSUBACK_PROPS__ [reflink2 unsuback_props async_mqtt5::unsuback_props]]
[def __DISCONNECT_PROPS__ [reflink2 disconnect_props async_mqtt5::disconnect_props]]
[def __AUTH_PROPS__ [reflink2 auth_props async_mqtt5::auth_props]]
[def __ERROR_CODE__ [reflink2 error_code `async_mqtt5::error_code`]]
[def __REASON_CODE__ [reflink2 Reason_codes `async_mqtt5::reason_code`]]
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
[include 01_intro.qbk]
[section:ref Reference]
[mqtt-client] reason codes & properties documented Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26113
2023-10-16 15:57:26 +02:00
[xinclude reference/quickref.xml]
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
[block'''<part label="Two: Reference">''']
[include reference.qbk]
[mqtt-client] reason codes & properties documented Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26113
2023-10-16 15:57:26 +02:00
[include reference/ExecutionContext.qbk]
[include reference/StreamType.qbk]
[include reference/TlsContext.qbk]
[mqtt-client] section about packet properties improved Summary: related to T12804 - all properties now have usage & example paragraph - each property has its own page Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26127
2023-10-17 11:51:14 +02:00
[mqtt-client] reason codes & properties documented Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26113
2023-10-16 15:57:26 +02:00
[include reference/reason_codes/Reason_codes.qbk]
[mqtt-client] section about packet properties improved Summary: related to T12804 - all properties now have usage & example paragraph - each property has its own page Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26127
2023-10-17 11:51:14 +02:00
[mqtt-client] A lot of various document changes Summary: related to T12804 - property files are now lowercase and match code names - properties properly link to their pages - packet names do not automatically link anymore - TlsContext documented - types inside handler signatures properly link to their pages next up: better error code documentation Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D26155
2023-10-18 12:16:05 +02:00
[include reference/properties/will_props.qbk]
[include reference/properties/connect_props.qbk]
[include reference/properties/connack_props.qbk]
[include reference/properties/publish_props.qbk]
[include reference/properties/puback_props.qbk]
[include reference/properties/pubrec_props.qbk]
[include reference/properties/pubrel_props.qbk]
[include reference/properties/pubcomp_props.qbk]
[include reference/properties/subscribe_props.qbk]
[include reference/properties/suback_props.qbk]
[include reference/properties/unsubscribe_props.qbk]
[include reference/properties/unsuback_props.qbk]
[include reference/properties/disconnect_props.qbk]
[include reference/properties/auth_props.qbk]
[mqtt-client] documentation setup Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D26026
2023-10-13 09:07:56 +02:00
[block'''</part>''']
[endsect]
Reference in New Issue Copy Permalink