Rebuild docs to make them easier to maintain

This commit is contained in:
Nick O'Leary
2020-05-21 01:17:42 +01:00
parent 09a3de6a09
commit a9d9bad1ff
35 changed files with 716 additions and 590 deletions

View File

@ -0,0 +1,23 @@
---
tag: api
type: function
name: subscribe
params:
- name: topic
description: the topic to subscribe to
type: const char[]
- name: qos
optional: true
description: the qos to subscribe at
type: 'int: 0 or 1 only'
returns:
type: boolean
values:
- value: 'false'
description: sending the subscribe failed, either connection lost or message too large
- value: 'true'
description: sending the subscribe succeeded
---
Subscribes to messages published to the specified topic.