From b6c2ff17e71da23f19ba9be89c1545899a945d09 Mon Sep 17 00:00:00 2001 From: Kayce Basques Date: Thu, 29 Jun 2023 22:54:29 +0000 Subject: [PATCH] pw_digital_io: Doxygenify the provides_* methods Change-Id: Ide224aa87374823751e8a0f5086c9c98d3bb5e03 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/153192 Reviewed-by: Kayce Basques Reviewed-by: Anton Markov Pigweed-Auto-Submit: Kayce Basques Commit-Queue: Auto-Submit --- pw_digital_io/docs.rst | 1 + pw_digital_io/public/pw_digital_io/digital_io.h | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/pw_digital_io/docs.rst b/pw_digital_io/docs.rst index 5ef4bc2c45..ca0e4d152d 100644 --- a/pw_digital_io/docs.rst +++ b/pw_digital_io/docs.rst @@ -279,6 +279,7 @@ API reference This API reference is incomplete. .. doxygenclass:: pw::digital_io::DigitalIoOptional + :members: ------------ Dependencies diff --git a/pw_digital_io/public/pw_digital_io/digital_io.h b/pw_digital_io/public/pw_digital_io/digital_io.h index ec529cb2eb..4dee625f35 100644 --- a/pw_digital_io/public/pw_digital_io/digital_io.h +++ b/pw_digital_io/public/pw_digital_io/digital_io.h @@ -70,11 +70,11 @@ class DigitalIoOptional { public: virtual ~DigitalIoOptional() = default; - // True if input (getting state) is supported. + /// @returns `true` if input (getting state) is supported. constexpr bool provides_input() const { return config_.input; } - // True if output (setting state) is supported. + /// @returns `true` if output (setting state) is supported. constexpr bool provides_output() const { return config_.output; } - // True if interrupt handlers can be registered. + /// @returns `true` if interrupt handlers can be registered. constexpr bool provides_interrupt() const { return config_.interrupt; } // Get the state of the line.