X-Git-Url: https://git.ao2.it/libam7xxx.git/blobdiff_plain/b3cc25c31d6bfc95aa1bd8a63c85f0b5cab60d11..575c6d3423fc3b93729c61f0a9a45469cb62faeb:/src/am7xxx.h diff --git a/src/am7xxx.h b/src/am7xxx.h index 885cef2..24636c3 100644 --- a/src/am7xxx.h +++ b/src/am7xxx.h @@ -244,17 +244,18 @@ int am7xxx_send_image(am7xxx_device *dev, /** * Set the power mode of an am7xxx device. * - * \note If we set the mode to AM7XXX_POWER_OFF we can't turn the - * display on again by using only am7xxx_set_power_mode(). This needs to be - * investigated, maybe some other command can reset the device. + * @note When setting the mode to AM7XXX_POWER_OFF the display can't be turned + * on again by using only am7xxx_set_power_mode(), am7xxx_set_zoom_mode() has + * to be called first, the current guess is that the latter performs some + * other resets beside setting the zoom mode. * - * @param[in] dev A pointer to the structure representing the device to get info of - * @param[in] mode The power mode to put the device in (see @link am7xxx_power_mode @endlink enum) + * @param[in] dev A pointer to the structure representing the device to set power mode to + * @param[in] power The power mode to put the device in (see #am7xxx_power_mode enum) * * @return 0 on success, a negative value on error * */ -int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode); +int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power); /** * Set the zoom mode of an am7xxx device.