Commit Graph

9 Commits

Author SHA1 Message Date
Korina Šimičević
c8036c0d46 [mqtt-client] added chapter on different ways to establish network connection
Summary:
related to T12804
	- added chapter on network connection
	- added code examples
	- remove any_authenticator from doc targets
	- manually create table of contents

Reviewers: ivica

Reviewed By: ivica

Subscribers: miljen, iljazovic

Differential Revision: https://repo.mireo.local/D26401
2023-11-03 14:15:35 +01:00
Bruno Iljazovic
7e60e7a919 [mqtt-client] add support for enhanced authentication
Summary:
- Relates to T12899
- TODO: support re-authentication

Reviewers: ivica

Reviewed By: ivica

Subscribers: korina

Maniphest Tasks: T12899

Differential Revision: https://repo.mireo.local/D26327
2023-11-03 09:01:26 +01:00
Korina Šimičević
e7227d70ec [mqtt-client] coroutine & callback examples
Summary:
related to T12804
	- added asio::no_recovery to list of possible error codes
	- added examples with asio::use_awaitable and callbacks as completion tokens

Reviewers: ivica

Reviewed By: ivica

Subscribers: miljen, iljazovic

Differential Revision: https://repo.mireo.local/D26355
2023-11-02 08:01:03 +01:00
Korina Šimičević
2f1f910552 [mqtt-client] some doc fixes
Summary:
related to T12804

- b2 rebuilds when documented .hpp files are changed

- some text changes

- some link fixes

Reviewers: ivica

Reviewed By: ivica

Subscribers: miljen

Differential Revision: https://repo.mireo.local/D26240
2023-10-26 13:42:51 +02:00
Korina Šimičević
64cb24dbd6 [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
2023-10-24 07:59:52 +02:00
Korina Šimičević
7cb1a877a3 [mqtt-client] slightly better error code documentation
Summary: related to T12804

Reviewers: ivica

Reviewed By: ivica

Subscribers: miljen, iljazovic

Differential Revision: https://repo.mireo.local/D26165
2023-10-20 11:28:19 +02:00
Korina Šimičević
62d7eb21b2 [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 15:34:37 +02:00
Korina Šimičević
402b8bf0b1 [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 13:08:09 +02:00
Korina Šimičević
22f1330fed [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-17 09:29:12 +02:00