Skip to content

Commit 2c4e67e

Browse files
committed
stmhal, pin: Update documentation.
1 parent 3d94555 commit 2c4e67e

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

stmhal/pin.c

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -527,9 +527,9 @@ STATIC mp_obj_t pin_pull(mp_obj_t self_in) {
527527
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pin_pull_obj, pin_pull);
528528

529529
/// \method af()
530-
/// Returns the currently configured af of the pin. The integer returned
531-
/// will match one of the allowed constants for the af argument to the init
532-
/// function.
530+
/// Returns the currently configured alternate-function of the pin. The
531+
/// integer returned will match one of the allowed constants for the af
532+
/// argument to the init function.
533533
STATIC mp_obj_t pin_af(mp_obj_t self_in) {
534534
return MP_OBJ_NEW_SMALL_INT(pin_get_af(self_in));
535535
}
@@ -564,6 +564,9 @@ STATIC const mp_map_elem_t pin_locals_dict_table[] = {
564564
/// \constant IN - initialise the pin to input mode
565565
/// \constant OUT_PP - initialise the pin to output mode with a push-pull drive
566566
/// \constant OUT_OD - initialise the pin to output mode with an open-drain drive
567+
/// \constant AF_PP - initialise the pin to alternate-function mode with a push-pull drive
568+
/// \constant AF_OD - initialise the pin to alternate-function mode with an open-drain drive
569+
/// \constant ANALOG - initialise the pin to analog mode
567570
/// \constant PULL_NONE - don't enable any pull up or down resistors on the pin
568571
/// \constant PULL_UP - enable the pull-up resistor on the pin
569572
/// \constant PULL_DOWN - enable the pull-down resistor on the pin

0 commit comments

Comments
 (0)