From 7ea75edc7c415af928cbcbceaa0d14910edbd6f9 Mon Sep 17 00:00:00 2001 From: RFulchiero Date: Fri, 12 Oct 2018 17:11:06 -0500 Subject: [PATCH] PortOut.h: Documentation improvements only * Improve function and parameter descriptions --- drivers/PortOut.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/drivers/PortOut.h b/drivers/PortOut.h index ccdcc25dbf..8df644e56c 100644 --- a/drivers/PortOut.h +++ b/drivers/PortOut.h @@ -25,7 +25,7 @@ namespace mbed { /** \addtogroup drivers */ -/** A multiple pin digital out +/** A multiple pin digital output * * @note Synchronization level: Interrupt safe * @@ -54,10 +54,10 @@ namespace mbed { class PortOut { public: - /** Create an PortOut, connected to the specified port + /** Create a PortOut, connected to the specified port * - * @param port Port to connect to (Port0-Port5) - * @param mask A bitmask to identify which bits in the port should be included (0 - ignore) + * @param port Port to connect to (as defined in target's PortNames.h) + * @param mask Bitmask defines which port pins are an output (0 - ignore, 1 - include) */ PortOut(PortName port, int mask = 0xFFFFFFFF) { @@ -78,7 +78,7 @@ public: /** Read the value currently output on the port * * @returns - * An integer with each bit corresponding to associated PortOut pin setting + * An integer with each bit corresponding to associated pin value */ int read() {