ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #8421 from TacoGrandeTX/doc_fix_portout 

PortOut.h: Documentation improvements only
pull/8465/head
Cruz Monrreal 2018-10-18 12:28:18 -05:00 committed by GitHub
parent 8a5b9ff893 7ea75edc7c
commit 6ce8f2fce8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
drivers/PortOut.h
View File

@ -25,7 +25,7 @@
namespace mbed { namespace mbed {
/** \addtogroup drivers */ /** \addtogroup drivers */
/** A multiple pin digital out /** A multiple pin digital output
* *
* @note Synchronization level: Interrupt safe * @note Synchronization level: Interrupt safe
* *
@ -54,10 +54,10 @@ namespace mbed {
class PortOut { class PortOut {
public: 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 port Port to connect to (as defined in target's PortNames.h)
* @param mask A bitmask to identify which bits in the port should be included (0 - ignore) * @param mask Bitmask defines which port pins are an output (0 - ignore, 1 - include)
*/ */
PortOut(PortName port, int mask = 0xFFFFFFFF) PortOut(PortName port, int mask = 0xFFFFFFFF)
{ {
@ -78,7 +78,7 @@ public:
/** Read the value currently output on the port /** Read the value currently output on the port
* *
* @returns * @returns
* An integer with each bit corresponding to associated PortOut pin setting * An integer with each bit corresponding to associated pin value
*/ */
int read() int read()
{ {