Skip to content

PortOut.h: Documentation improvements only #8421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 18, 2018
Merged

PortOut.h: Documentation improvements only #8421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions drivers/PortOut.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

namespace mbed {
/** \addtogroup drivers */
/** A multiple pin digital out
/** A multiple pin digital output
*
* @note Synchronization level: Interrupt safe
*
Expand Down Expand Up @@ -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)
{
Expand All @@ -78,7 +78,7 @@ class PortOut {
/** 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()
{
Expand Down