Skip to content

Commit 6ce8f2f

Browse files
author
Cruz Monrreal
authored
Merge pull request #8421 from TacoGrandeTX/doc_fix_portout
PortOut.h: Documentation improvements only
2 parents 8a5b9ff + 7ea75ed commit 6ce8f2f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

drivers/PortOut.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
namespace mbed {
2727
/** \addtogroup drivers */
28-
/** A multiple pin digital out
28+
/** A multiple pin digital output
2929
*
3030
* @note Synchronization level: Interrupt safe
3131
*
@@ -54,10 +54,10 @@ namespace mbed {
5454
class PortOut {
5555
public:
5656

57-
/** Create an PortOut, connected to the specified port
57+
/** Create a PortOut, connected to the specified port
5858
*
59-
* @param port Port to connect to (Port0-Port5)
60-
* @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
59+
* @param port Port to connect to (as defined in target's PortNames.h)
60+
* @param mask Bitmask defines which port pins are an output (0 - ignore, 1 - include)
6161
*/
6262
PortOut(PortName port, int mask = 0xFFFFFFFF)
6363
{
@@ -78,7 +78,7 @@ class PortOut {
7878
/** Read the value currently output on the port
7979
*
8080
* @returns
81-
* An integer with each bit corresponding to associated PortOut pin setting
81+
* An integer with each bit corresponding to associated pin value
8282
*/
8383
int read()
8484
{

0 commit comments

Comments
 (0)