From 64cb24dbd6b8e7ce08e1d4c546abea69fc99509d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Korina=20=C5=A0imi=C4=8Devi=C4=87?= Date: Mon, 23 Oct 2023 15:45:56 +0200 Subject: [PATCH] [mqtt-client] doc generation no longer uses docca Summary: related to T12804 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D26219 --- doc/Jamfile | 65 +- doc/doxy2qbk.sh | 8 + doc/qbk/00_main.qbk | 36 +- doc/qbk/reference/Error_handling.qbk | 2 +- .../reference/concepts/ExecutionContext.qbk | 2 +- doc/qbk/reference/concepts/StreamType.qbk | 2 +- doc/qbk/reference/concepts/TlsContext.qbk | 2 +- doc/qbk/reference/properties/auth_props.qbk | 2 +- .../reference/properties/connack_props.qbk | 2 +- .../reference/properties/connect_props.qbk | 2 +- .../reference/properties/disconnect_props.qbk | 2 +- doc/qbk/reference/properties/puback_props.qbk | 2 +- .../reference/properties/pubcomp_props.qbk | 2 +- .../reference/properties/publish_props.qbk | 2 +- doc/qbk/reference/properties/pubrec_props.qbk | 2 +- doc/qbk/reference/properties/pubrel_props.qbk | 2 +- doc/qbk/reference/properties/suback_props.qbk | 2 +- .../reference/properties/subscribe_props.qbk | 2 +- .../reference/properties/unsuback_props.qbk | 2 +- .../properties/unsubscribe_props.qbk | 2 +- doc/qbk/reference/properties/will_props.qbk | 2 +- doc/qbk/reference/quickref.xml | 64 +- .../reference/reason_codes/Reason_codes.qbk | 2 +- doc/qbk/reference/reason_codes/rcref.xml | 86 +- doc/reference.dox | 212 +++ doc/reference.xsl | 1588 +++++++++++++++++ doc/xsl/custom-overrides.xsl | 38 - include/async_mqtt5/mqtt_client.hpp | 6 +- include/async_mqtt5/types.hpp | 2 +- 29 files changed, 1913 insertions(+), 230 deletions(-) create mode 100644 doc/doxy2qbk.sh create mode 100644 doc/reference.dox create mode 100644 doc/reference.xsl delete mode 100644 doc/xsl/custom-overrides.xsl diff --git a/doc/Jamfile b/doc/Jamfile index f846fd0..0cf90be 100644 --- a/doc/Jamfile +++ b/doc/Jamfile @@ -17,74 +17,15 @@ using doxygen ; if [ os.name ] = MACOSX { - using saxonhe - : $(BOOST_ROOT)3rdParty/boost-doc/saxon/Saxon-HE.jar - : /usr/bin/java - ; using quickbook : $(BOOST_ROOT)build/macos-arm64-release/bin/quickbook ; } else if [ os.name ] = LINUX { - using saxonhe - : $(BOOST_ROOT)3rdParty/boost-doc/saxon/Saxon-HE.jar - : /usr/bin/java - ; using quickbook : $(BOOST_ROOT)build/linux-native-x64-release/bin/quickbook ; } import boostbook ; -# unfortunately, it can only import docca.jam in relative path format -import ../../../../3rdParty/boost-doc/docca/docca.jam ; - -local doxygen_exclussions = - detail - impl - property_types.hpp -; - -docca.reference reference.qbk - : - xsl/custom-overrides.xsl - [ glob-tree-ex ../include/async_mqtt5/ : *.hpp : $(doxygen_exclussions) ] - : - PROJECT_NAME=async_mqtt5 - PROJECT_BRIEF="MQTT C++ Client Library" - DISTRIBUTE_GROUP_DOC=YES - ENABLE_PREPROCESSING=YES - MACRO_EXPANSION=YES - EXPAND_ONLY_PREDEF=YES - SEARCH_INCLUDES=NO - "PREDEFINED=\\ - \"BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=auto\" \\ - \"BOOST_ASIO_COMPLETION_TOKEN_FOR(sig)=class\" \\ - \"BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(ct,sig)=auto\" \\ - \"BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(ex)=\" \\ - \"BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(ex)=\" \\ - \"protected=private\" \\ - \"BOOST_CXX14_CONSTEXPR=constexpr\" \\ - " - SKIP_FUNCTION_MACROS=NO - OUTPUT_LANGUAGE=English - INLINE_INHERITED_MEMB=YES - AUTOLINK_SUPPORT=NO - BRIEF_MEMBER_DESC=NO - EXTRACT_ALL=YES - HAVE_DOT=NO - HIDE_UNDOC_MEMBERS=YES - HIDE_UNDOC_CLASSES=YES - HIDE_FRIEND_COMPOUNDS=YES - CASE_SENSE_NAMES=YES - SHOW_INCLUDE_FILES=NO - INLINE_INFO=NO - SORT_MEMBER_DOCS=NO - SORT_MEMBERS_CTORS_1ST=YES - SHOW_USED_FILES=NO - SHOW_FILES=NO - SHOW_NAMESPACES=NO - QUIET=NO -; - install stylesheets : $(BOOST_ROOT)3rdParty/boost-doc/style/boostbook.css @@ -116,7 +57,7 @@ xml async_mqtt5_doc : qbk/00_main.qbk : - reference.qbk + qbk/reference/reference.qbk images ; @@ -132,8 +73,8 @@ boostbook async_mqtt5 chapter.autolabel=1 chunk.section.depth=8 chunk.first.sections=1 - toc.section.depth=8 - toc.max.depth=8 + toc.section.depth=2 + toc.max.depth=1 generate.toc="chapter toc,title section nop reference nop part toc" html.stylesheet=boostbook.css : diff --git a/doc/doxy2qbk.sh b/doc/doxy2qbk.sh new file mode 100644 index 0000000..d5dc687 --- /dev/null +++ b/doc/doxy2qbk.sh @@ -0,0 +1,8 @@ +#! /bin/bash + +doxygen reference.dox +cd xml +xsltproc combine.xslt index.xml > all.xml +cd .. +xsltproc reference.xsl xml/all.xml > qbk/reference/reference.qbk +rm -rf xml diff --git a/doc/qbk/00_main.qbk b/doc/qbk/00_main.qbk index 11dd39f..9749164 100644 --- a/doc/qbk/00_main.qbk +++ b/doc/qbk/00_main.qbk @@ -15,11 +15,12 @@ [template nochunk[] [block '''''']] [template mdash[] '''— '''] +[template hr[] [br]''''''[mdash]''''''[br]] [template include_file[path][^<''''''[path]''''''>]] [template indexterm1[term1] ''''''[term1]''''''] [template indexterm2[term1 term2] ''''''[term1]''''''[term2]''''''] -[template reflink2[id text][link async_mqtt5.ref.async_mqtt5__[id] [^[text]]]] +[template reflink2[id text][link async_mqtt5.ref.[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]]] @@ -48,6 +49,7 @@ [def __RETAIN_AVAILABLE__ [mqttlink 3901085 `Retain Available`]] [def __TOPIC_ALIAS_MAX__ [mqttlink 3901051 `Topic Alias Maximum`]] [def __QOS__ [mqttlink 3901234 `QoS`]] +[def __RETAIN__ [mqttlink 3901104 `RETAIN`]] [def __SUBSCRIBE_OPTIONS__ [mqttlink 3901169 `Subscribe Options`]] [def __CONNECT__ [mqttlink 3901033 `CONNECT`]] @@ -89,34 +91,4 @@ [include 01_intro.qbk] -[section:ref Reference] -[xinclude reference/quickref.xml] - -[block''''''] -[include reference.qbk] - -[include reference/Error_handling.qbk] - -[include reference/concepts/ExecutionContext.qbk] -[include reference/concepts/StreamType.qbk] -[include reference/concepts/TlsContext.qbk] - -[include reference/reason_codes/Reason_codes.qbk] - -[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] -[block''''''] -[endsect] - +[include reference/reference.qbk] diff --git a/doc/qbk/reference/Error_handling.qbk b/doc/qbk/reference/Error_handling.qbk index 3b36f6c..cb056bd 100644 --- a/doc/qbk/reference/Error_handling.qbk +++ b/doc/qbk/reference/Error_handling.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__Error_handling Error handling] +[section:Error_handling Error handling] The table below provides a reference of all __ERROR_CODE__ instances that asynchronous operations may complete with, along with the reasons for their occurrence. diff --git a/doc/qbk/reference/concepts/ExecutionContext.qbk b/doc/qbk/reference/concepts/ExecutionContext.qbk index ca01e9c..549fcff 100644 --- a/doc/qbk/reference/concepts/ExecutionContext.qbk +++ b/doc/qbk/reference/concepts/ExecutionContext.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__ExecutionContext ExecutionContext concept] +[section:ExecutionContext ExecutionContext concept] `ExecutionContext` represents a place where function objects will be executed. diff --git a/doc/qbk/reference/concepts/StreamType.qbk b/doc/qbk/reference/concepts/StreamType.qbk index 20ef253..0388152 100644 --- a/doc/qbk/reference/concepts/StreamType.qbk +++ b/doc/qbk/reference/concepts/StreamType.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__StreamType StreamType concept] +[section:StreamType StreamType concept] `StreamType` represents the transport protocol type used to transfer stream of bytes. diff --git a/doc/qbk/reference/concepts/TlsContext.qbk b/doc/qbk/reference/concepts/TlsContext.qbk index 440ce5e..cc816d0 100644 --- a/doc/qbk/reference/concepts/TlsContext.qbk +++ b/doc/qbk/reference/concepts/TlsContext.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__TlsContext TlsContext concept] +[section:TlsContext TlsContext concept] `TlsContext` represents an object that defines user's configuration for establishing TLS/SSL connections. diff --git a/doc/qbk/reference/properties/auth_props.qbk b/doc/qbk/reference/properties/auth_props.qbk index 9092081..6a290ef 100644 --- a/doc/qbk/reference/properties/auth_props.qbk +++ b/doc/qbk/reference/properties/auth_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__auth_props AUTH properties] +[section:auth_props AUTH properties] The last field in the Variable header of __AUTH__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/connack_props.qbk b/doc/qbk/reference/properties/connack_props.qbk index d9a4ed5..b6f0e1f 100644 --- a/doc/qbk/reference/properties/connack_props.qbk +++ b/doc/qbk/reference/properties/connack_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__connack_props CONNACK properties] +[section:connack_props CONNACK properties] The last field in the Variable header of __CONNACK__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/connect_props.qbk b/doc/qbk/reference/properties/connect_props.qbk index 5bb7b01..b42b873 100644 --- a/doc/qbk/reference/properties/connect_props.qbk +++ b/doc/qbk/reference/properties/connect_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__connect_props CONNECT properties] +[section:connect_props CONNECT properties] The last field in the Variable header of __CONNECT__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/disconnect_props.qbk b/doc/qbk/reference/properties/disconnect_props.qbk index 5473616..d621ee9 100644 --- a/doc/qbk/reference/properties/disconnect_props.qbk +++ b/doc/qbk/reference/properties/disconnect_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__disconnect_props DISCONNECT properties] +[section:disconnect_props DISCONNECT properties] The last field in the Variable header of __DISCONNECT__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/puback_props.qbk b/doc/qbk/reference/properties/puback_props.qbk index c14bc5e..40a57c2 100644 --- a/doc/qbk/reference/properties/puback_props.qbk +++ b/doc/qbk/reference/properties/puback_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__puback_props PUBACK properties] +[section:puback_props PUBACK properties] The last field in the Variable header of __PUBACK__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/pubcomp_props.qbk b/doc/qbk/reference/properties/pubcomp_props.qbk index 53e8172..001a450 100644 --- a/doc/qbk/reference/properties/pubcomp_props.qbk +++ b/doc/qbk/reference/properties/pubcomp_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__pubcomp_props PUBCOMP properties] +[section:pubcomp_props PUBCOMP properties] The last field in the Variable header of __PUBCOMP__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/publish_props.qbk b/doc/qbk/reference/properties/publish_props.qbk index a378ae3..1dcf481 100644 --- a/doc/qbk/reference/properties/publish_props.qbk +++ b/doc/qbk/reference/properties/publish_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__publish_props PUBLISH properties] +[section:publish_props PUBLISH properties] The last field in the Variable header of __PUBLISH__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/pubrec_props.qbk b/doc/qbk/reference/properties/pubrec_props.qbk index 64ce91c..56c1c9e 100644 --- a/doc/qbk/reference/properties/pubrec_props.qbk +++ b/doc/qbk/reference/properties/pubrec_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__pubrec_props PUBREC properties] +[section:pubrec_props PUBREC properties] The last field in the Variable header of __PUBREC__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/pubrel_props.qbk b/doc/qbk/reference/properties/pubrel_props.qbk index a44a29c..b603a7a 100644 --- a/doc/qbk/reference/properties/pubrel_props.qbk +++ b/doc/qbk/reference/properties/pubrel_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__pubrel_props PUBREL properties] +[section:pubrel_props PUBREL properties] The last field in the Variable header of __PUBREL__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/suback_props.qbk b/doc/qbk/reference/properties/suback_props.qbk index f39142c..cb9f63a 100644 --- a/doc/qbk/reference/properties/suback_props.qbk +++ b/doc/qbk/reference/properties/suback_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__suback_props SUBACK properties] +[section:suback_props SUBACK properties] The last field in the Variable header of __SUBACK__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/subscribe_props.qbk b/doc/qbk/reference/properties/subscribe_props.qbk index 5889c7c..461cabf 100644 --- a/doc/qbk/reference/properties/subscribe_props.qbk +++ b/doc/qbk/reference/properties/subscribe_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__subscribe_props SUBSCRIBE properties] +[section:subscribe_props SUBSCRIBE properties] The last field in the Variable header of __SUBSCRIBE__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/unsuback_props.qbk b/doc/qbk/reference/properties/unsuback_props.qbk index 4799065..89c8870 100644 --- a/doc/qbk/reference/properties/unsuback_props.qbk +++ b/doc/qbk/reference/properties/unsuback_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__unsuback_props UNSUBACK properties] +[section:unsuback_props UNSUBACK properties] The last field in the Variable header of __UNSUBACK__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/unsubscribe_props.qbk b/doc/qbk/reference/properties/unsubscribe_props.qbk index 3a8ae82..05b217b 100644 --- a/doc/qbk/reference/properties/unsubscribe_props.qbk +++ b/doc/qbk/reference/properties/unsubscribe_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__unsubscribe_props UNSUBSCRIBE properties] +[section:unsubscribe_props UNSUBSCRIBE properties] The last field in the Variable header of __UNSUBSCRIBE__ packet is a set of Properties. A set contains a Property Length followed by the Properties. A Property consists of an Identifier and a value. diff --git a/doc/qbk/reference/properties/will_props.qbk b/doc/qbk/reference/properties/will_props.qbk index 10c0493..26b3617 100644 --- a/doc/qbk/reference/properties/will_props.qbk +++ b/doc/qbk/reference/properties/will_props.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__will_props Will properties] +[section:will_props Will properties] The Will Properties consist of the properties that determine when to publish the [reflink2 will Will] Message and the Application Message properties to be sent with the [reflink2 will Will] Message. The Will Properties consists of a Property Length and the Properties. diff --git a/doc/qbk/reference/quickref.xml b/doc/qbk/reference/quickref.xml index ef0585a..e1c18c2 100644 --- a/doc/qbk/reference/quickref.xml +++ b/doc/qbk/reference/quickref.xml @@ -15,62 +15,62 @@ Classes - authority_path - mqtt_client - reason_code - subscribe_options - subscribe_topic - will + authority_path + mqtt_client + reason_code + subscribe_options + subscribe_topic + will Concepts - ExecutionContext - StreamType - TlsContext + ExecutionContext + StreamType + TlsContext Type aliases - error_code + error_code Enumerations - client_error - disconnect_rc_e - qos_e - retain_e + client_error + disconnect_rc_e + qos_e + retain_e Functions - get_error_code_category - make_error_code + get_error_code_category + make_error_code Properties - will_props - connect_props - connack_props - publish_props - puback_props - pubrec_props - pubrel_props - pubcomp_props - subscribe_props - suback_props - unsubscribe_props - unsuback_props - disconnect_props - auth_props + will_props + connect_props + connack_props + publish_props + puback_props + pubrec_props + pubrel_props + pubcomp_props + subscribe_props + suback_props + unsubscribe_props + unsuback_props + disconnect_props + auth_props Reference tables - Reason codes - Error handling + Reason codes + Error handling diff --git a/doc/qbk/reference/reason_codes/Reason_codes.qbk b/doc/qbk/reference/reason_codes/Reason_codes.qbk index 2373923..0d6b7d4 100644 --- a/doc/qbk/reference/reason_codes/Reason_codes.qbk +++ b/doc/qbk/reference/reason_codes/Reason_codes.qbk @@ -5,7 +5,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] -[section:async_mqtt5__Reason_codes Reason codes] +[section:Reason_codes Reason codes] This section lists all possible __REASON_CODE__ instances representing Reason Codes that can be found in MQTT Control Packets. diff --git a/doc/qbk/reference/reason_codes/rcref.xml b/doc/qbk/reference/reason_codes/rcref.xml index ae59fc1..a34ab86 100644 --- a/doc/qbk/reference/reason_codes/rcref.xml +++ b/doc/qbk/reference/reason_codes/rcref.xml @@ -15,59 +15,59 @@ Success - continue_authentication - disconnect_with_will_message - granted_qos_0 - granted_qos_1 - granted_qos_2 - no_matching_subscribers - no_subscription_existed - normal_disconnection - reauthenticate - success + continue_authentication + disconnect_with_will_message + granted_qos_0 + granted_qos_1 + granted_qos_2 + no_matching_subscribers + no_subscription_existed + normal_disconnection + reauthenticate + success Error - administrative_action - bad_authentication_method - bad_username_or_password - banned - client_id_not_valid - connection_rate_exceeded - implementation_specific_error - keep_alive_timeout - maximum_connect_time - message_rate_too_high - not_authorized - packet_id_in_use - packet_id_not_found - packet_too_large - payload_format_invalid - qos_not_supported - quota_exceeded - receive_maximum_exceeded - retain_not_supported - server_busy - server_moved - server_shutting_down - server_unavailable - session_taken_over - shared_subscriptions_not_supported - subscription_ids_not_supported - topic_alias_invalid - topic_filter_invalid - topic_name_invalid - unsupported_protocol_version - use_another_server - wildcard_subscriptions_not_supported + administrative_action + bad_authentication_method + bad_username_or_password + banned + client_id_not_valid + connection_rate_exceeded + implementation_specific_error + keep_alive_timeout + maximum_connect_time + message_rate_too_high + not_authorized + packet_id_in_use + packet_id_not_found + packet_too_large + payload_format_invalid + qos_not_supported + quota_exceeded + receive_maximum_exceeded + retain_not_supported + server_busy + server_moved + server_shutting_down + server_unavailable + session_taken_over + shared_subscriptions_not_supported + subscription_ids_not_supported + topic_alias_invalid + topic_filter_invalid + topic_name_invalid + unsupported_protocol_version + use_another_server + wildcard_subscriptions_not_supported Special - empty + empty diff --git a/doc/reference.dox b/doc/reference.dox new file mode 100644 index 0000000..7367054 --- /dev/null +++ b/doc/reference.dox @@ -0,0 +1,212 @@ +# Doxyfile 1.9.8 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "async_mqtt5 reference" +PROJECT_NUMBER = +OUTPUT_DIRECTORY = . +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = ./../../../ +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = YES +INHERIT_DOCS = NO +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 2 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = NO +INLINE_INFO = NO +SORT_MEMBER_DOCS = NO +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = NO +GENERATE_BUGLIST = NO +GENERATE_DEPRECATEDLIST= NO +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../include/async_mqtt5/error.hpp \ + ../include/async_mqtt5/types.hpp \ + ../include/async_mqtt5/mqtt_client.hpp +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = YES +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +USE_HTAGS = NO +VERBATIM_HEADERS = NO +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = NO +HTML_OUTPUT = . +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = YES +ENUM_VALUES_PER_LINE = 1 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = YES +XML_OUTPUT = xml +XML_PROGRAMLISTING = NO +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO +GROUP_GRAPHS = NO +UML_LOOK = NO +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = NO +INCLUDED_BY_GRAPH = NO +CALL_GRAPH = NO +GRAPHICAL_HIERARCHY = NO +DIRECTORY_GRAPH = NO +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_DEPTH = 0 +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = NO +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO diff --git a/doc/reference.xsl b/doc/reference.xsl new file mode 100644 index 0000000..da161b7 --- /dev/null +++ b/doc/reference.xsl @@ -0,0 +1,1588 @@ + + + + + + + + + + + + + + + + + + + +[/ + /Copyright (c) 2023 Mireo + / + /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) +/] + +[section:ref Reference] +[xinclude quickref.xml] + +[include Error_handling.qbk] +[include concepts/ExecutionContext.qbk] +[include concepts/StreamType.qbk] +[include concepts/TlsContext.qbk] +[include reason_codes/Reason_codes.qbk] +[include properties/will_props.qbk] +[include properties/connect_props.qbk] +[include properties/connack_props.qbk] +[include properties/publish_props.qbk] +[include properties/puback_props.qbk] +[include properties/pubrec_props.qbk] +[include properties/pubrel_props.qbk] +[include properties/pubcomp_props.qbk] +[include properties/subscribe_props.qbk] +[include properties/suback_props.qbk] +[include properties/unsubscribe_props.qbk] +[include properties/unsuback_props.qbk] +[include properties/disconnect_props.qbk] +[include properties/auth_props.qbk] + + + + + + + + + + + + + + + + + + + + + + [endsect] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + query__static + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +[heading ] + + + + + + + + + + + + + + + + `` + + + + + + `` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +`` + + + + +`` + + + + +* + + + + + + + +[*] + + +['] + + + + +[heading Template Parameters] + + +[heading Parameters] + + +[heading Exceptions] + + + +[table + [[Name] [Description]] + +] + + + + +[[][]] + + + + + +[heading Return Value] + + + + + +[heading Remarks] + + + +[heading Attention] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \[ + + + + + + + \] + + + + + + + \.\.\. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [link async_mqtt5.ref. + + ` + + `] + + + ` + + ` + + + + + + + + + + + + + + + + + + + + + + + [link async_mqtt5.ref. + + ` + + `] + + + ` + + ` + + + + + + + + + + + + + + + + + + + + + + + [link async_mqtt5.ref. + + ` + + `] + + + ` + + ` + + + + + + + + + + + + + + + + + + + + + + + [link async_mqtt5.ref. + + ` + + `] + + + ` + + ` + + + + + + + + + [heading Requirements] + + + ['Header: ] + [^async_mqtt5/ + + ] + + + ['Convenience header: ] + [^async_mqtt5.hpp] + + + + + + + + + + + + + + + + + + + + + + + + + + + + +[section: ] + +[indexterm1 ] + + + + + + : + + public , + + + + + + + + + + + + + + + + + + + + + +[endsect] + + + + + + + + +[heading Types] +[table + [[Name][Description]] + + + [ + + + [[link async_mqtt5.ref.. + [*]]] + [] + + + + + + + + + + + + + + + + + + + [[link async_mqtt5.ref. + [*]]] + [] + + + ] + +] + + + +[heading Member Functions] +[table + [[Name][Description]] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [ + [[link async_mqtt5.ref.. + [*]] + [constructor] + [destructor] + [static] + ] + [ + + + + [hr] + + + + + + ] + ] + + + +] + + + +[heading Protected Member Functions] +[table + [[Name][Description]] + + + + + + + + + + + + + + + + + + + + + + + + + + [ + [[link async_mqtt5.ref.. + [*]] + [constructor] + [destructor] + [static] + ] + [ + + + + [hr] + + + + + + ] + ] + + + +] + + + + +[heading Private Member Functions] +[table + [[Name][Description]] + + + + + + + + + + + + + + + + + + + + + + + + + + [ + [[link async_mqtt5.ref.. + [*]] + [constructor] + [destructor] + [static] + ] + [ + + + + [hr] + + + + + + ] + ] + + + +] + + + + +[heading Data Members] +[table + [[Name][Description]] + + + [ + [[link async_mqtt5.ref.. + [*]] + [static]] + [] + ] + +] + + + +[heading Protected Data Members] +[table + [[Name][Description]] + + + [ + [[link async_mqtt5.ref.. + [*]] + [static]] + [] + ] + +] + + + +[heading Friends] +[table + [[Name][Description]] + + + + + + + + + + + + + + + + + + + + + + + + + [ + [[link async_mqtt5.ref.. + [*]]] + [ + + + + [hr] + + + + + + ] + ] + + + +] + + + +[heading Related Functions] +[table + [[Name][Description]] + + + + + + + + + + + + + + + + + + + + + + + + + [ + [[link async_mqtt5.ref.. + [*]]] + [ + + + + + + + + + ] + ] + + + +] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +[section: +::] + +[indexterm2 + +.. + +] + + + + + + + + + + + + + + explicit + static + virtual + + + + + + + +``[link async_mqtt5.ref...overload ]``() const; + `` [''''&raquo;''' + [link async_mqtt5.ref. +..overload + more...]]`` + + + + +[section: +overload + :: + ( of overloads)] + + + + +['Inherited from + +.] + + + + + [indexterm2 + + .. + + ] + + + + + + + + + + + + + + + + + + + + + + + + + + + + +[heading Description] + + + + + + + + + +[endsect] + + +[endsect] + + + + + + + + typedef ; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + template <typename T> + + + + template <typename U> + + + static + = + ; + + + + + + + enum + + class + + + + : unsigned int + + + + + + [indexterm2 + + .. + + ] + + +[heading Values] +[table + [[Name] [Description]] + + [[][]] + +] + + + + + + + + + + + + + + + + + + + + + + + + static virtual +() const; + + + + + template<> + + + + + + + + + typename __CompletionToken__ + + + typename __ExectionContext__ + + + typename __StreamType__ + + + typename __TlsContext__ + + + + + + + + + + + = + + , + + + + + + + + + + (& + + ) + + + + + + + + + , + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +[section: ] + +[indexterm1 + +] + + + + + + + + + + + + + + + + + + + ``[link async_mqtt5.ref..overload +]``(); + `` [''''&raquo;''' + [link async_mqtt5.ref. +.overload + more...]]`` + + + + + + + + + + + + + +[section: +overload + + ( of overloads)] + + + [indexterm1 + + ] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +[endsect] + + +[endsect] + + + + + diff --git a/doc/xsl/custom-overrides.xsl b/doc/xsl/custom-overrides.xsl deleted file mode 100644 index 643f045..0000000 --- a/doc/xsl/custom-overrides.xsl +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - - - - - - - - - - {$nl} - Convenience header [include_file {$convenience-header}] - {$nl} - - - - async_mqtt5.hpp - - - - - - diff --git a/include/async_mqtt5/mqtt_client.hpp b/include/async_mqtt5/mqtt_client.hpp index b3c7223..cf418ee 100644 --- a/include/async_mqtt5/mqtt_client.hpp +++ b/include/async_mqtt5/mqtt_client.hpp @@ -219,14 +219,14 @@ public: * \par Handler signature * The handler signature for this operation depends on the \ref qos_e specified:\n * - * - `qos_e::at_most_once`: + * \ref qos_e == `qos_e::at_most_once`: * \code * void ( * __ERROR_CODE__ // Result of operation * ) * \endcode * - * - `qos_e::at_least_once`: + * \ref qos_e == `qos_e::at_least_once`: * \code * void ( * __ERROR_CODE__, // Result of operation. @@ -235,7 +235,7 @@ public: * ) * \endcode * - * - `qos_e::exactly_once`: + * \ref qos_e == `qos_e::exactly_once`: * \code * void ( * __ERROR_CODE__, // Result of operation. diff --git a/include/async_mqtt5/types.hpp b/include/async_mqtt5/types.hpp index 8e4beb3..6149526 100644 --- a/include/async_mqtt5/types.hpp +++ b/include/async_mqtt5/types.hpp @@ -41,7 +41,7 @@ enum class qos_e : std::uint8_t { }; /** - * \brief Represents the RETAIN flag in the \__PUBLISH\__ packets. + * \brief Represents the \__RETAIN\__ flag in the \__PUBLISH\__ packets. * * \details This flag informs the Server about whether or not it should * store the current message.