From 977c8b46cba3aa0b86c471dde9c22a331515ed25 Mon Sep 17 00:00:00 2001 From: Rahix <rahix@rahix.de> Date: Fri, 2 Apr 2021 20:21:22 +0200 Subject: [PATCH] chore(docs): Fix remaining warnings/errors --- Documentation/bluetooth/ess.rst | 2 +- Documentation/pycardium/png.rst | 2 +- epicardium/epicardium.h | 4 ++-- epicardium/modules/stream.h | 1 + 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Documentation/bluetooth/ess.rst b/Documentation/bluetooth/ess.rst index eabc92ade..0d4005e23 100644 --- a/Documentation/bluetooth/ess.rst +++ b/Documentation/bluetooth/ess.rst @@ -17,7 +17,7 @@ If :ref:`bsec_api` is enabled the following additional estimates are available: - Indoor air quality (IAQ estimate - Equivalent CO2 (eCO2) estimate -Please refer to :ref:`bme680` for more information about BSEC. +Please refer to :py:mod:`bme680` for more information about BSEC. If notifcations are enabled a measurement of all values is performed every 3 seconds. For each measurement a notification is sent for the characteristics which have notifications enabled. diff --git a/Documentation/pycardium/png.rst b/Documentation/pycardium/png.rst index d4a4aa41c..18c7290a5 100644 --- a/Documentation/pycardium/png.rst +++ b/Documentation/pycardium/png.rst @@ -1,5 +1,5 @@ ``png`` - PNG Decoder -=============== +===================== The ``png`` module provides functions to decode PNG files into raw pixel data which can be displayed using the card10's display or its LEDs. diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h index 7908c74f0..b9e4df416 100644 --- a/epicardium/epicardium.h +++ b/epicardium/epicardium.h @@ -2631,7 +2631,7 @@ API(API_BLE_SET_MODE, void epic_ble_set_mode(bool bondable, bool scanner)); /** * Retrieve a scan report from the queue of scan reports. * - * :param struct epic_scan_report* rpt: Pointer where the report will be stored. + * :param struct\ epic_scan_report* rpt: Pointer where the report will be stored. * * :return: ``0`` on success or a negative value if an error occured. Possible * errors: @@ -2645,7 +2645,7 @@ API(API_BLE_GET_SCAN_REPORT, int epic_ble_get_scan_report(struct epic_scan_repor * Send an input report to the host. * * :param uint8_t report_id: The id of the report to use. 1: keyboard, 2: mouse, 3: consumer control - * :param uint8_t *data: Data to be reported. + * :param uint8_t* data: Data to be reported. * :param uint8_t len: Length in bytes of the data to be reported. Maximum length is 8 bytes. * * :return: ``0`` on success, ``1`` if the report is queued or a negative value diff --git a/epicardium/modules/stream.h b/epicardium/modules/stream.h index fe23b860a..6672de6a0 100644 --- a/epicardium/modules/stream.h +++ b/epicardium/modules/stream.h @@ -11,6 +11,7 @@ #include "queue.h" #else typedef unsigned int size_t; +typedef int bool; typedef void *QueueHandle_t; #endif /* __SPHINX_DOC */ -- GitLab