From 2c4e67e32d56929820e9ce10dd174cab9336c193 Mon Sep 17 00:00:00 2001 From: Damien George Date: Sun, 24 Aug 2014 18:30:22 +0100 Subject: [PATCH] stmhal, pin: Update documentation. --- stmhal/pin.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/stmhal/pin.c b/stmhal/pin.c index 3cbb3a3b49..02e8356e86 100644 --- a/stmhal/pin.c +++ b/stmhal/pin.c @@ -527,9 +527,9 @@ STATIC mp_obj_t pin_pull(mp_obj_t self_in) { STATIC MP_DEFINE_CONST_FUN_OBJ_1(pin_pull_obj, pin_pull); /// \method af() -/// Returns the currently configured af of the pin. The integer returned -/// will match one of the allowed constants for the af argument to the init -/// function. +/// Returns the currently configured alternate-function of the pin. The +/// integer returned will match one of the allowed constants for the af +/// argument to the init function. STATIC mp_obj_t pin_af(mp_obj_t self_in) { return MP_OBJ_NEW_SMALL_INT(pin_get_af(self_in)); } @@ -564,6 +564,9 @@ STATIC const mp_map_elem_t pin_locals_dict_table[] = { /// \constant IN - initialise the pin to input mode /// \constant OUT_PP - initialise the pin to output mode with a push-pull drive /// \constant OUT_OD - initialise the pin to output mode with an open-drain drive + /// \constant AF_PP - initialise the pin to alternate-function mode with a push-pull drive + /// \constant AF_OD - initialise the pin to alternate-function mode with an open-drain drive + /// \constant ANALOG - initialise the pin to analog mode /// \constant PULL_NONE - don't enable any pull up or down resistors on the pin /// \constant PULL_UP - enable the pull-up resistor on the pin /// \constant PULL_DOWN - enable the pull-down resistor on the pin