Skip to content

Commit

Permalink
Fix documentation for updated and new modules (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
niksiboxi committed Mar 9, 2021
1 parent b2b0fc5 commit f4d35c3
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions src/app_ble.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,10 @@ rd_status_t app_ble_modulation_enable (const ri_radio_modulation_t modulation,
/**
* @brief Start a scan sequence.
*
* Runs through enabled modulations and channels, automatically starting
* on next after one has finished. Calls given scan callback on data.
* Checks if any PHY is enabled. Runs through enabled modulations and channels,
* automatically starting on next after one has finished. Calls given scan
* callback on data. If all PHYs are disabled, calls app_ble_scan_stop() to
* stop scanning process until any PHY is reactivated.
*
* @retval RD_SUCCESS on success.
*
Expand All @@ -97,6 +99,14 @@ rd_status_t app_ble_scan_start (void);
*/
bool app_ble_manufacturer_filter_enabled (void);

/**
* @brief Stop a scan sequence.
*
* Aborts the scanning process.
*
* @retval RD_SUCCESS on success.
* @retval RD_ERROR_INVALID_STATE if scan is not initialized.
*/
rd_status_t app_ble_scan_stop (void);

#ifdef CEEDLING
Expand Down

0 comments on commit f4d35c3

Please sign in to comment.