Skip to content
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

Jump to bottom

BLE: Clarify ble event docs with crossreferences #14820

Merged
merged 3 commits into from
Jul 1, 2021
Merged

BLE: Clarify ble event docs with crossreferences #14820

merged 3 commits into from
Jul 1, 2021

Conversation

paul-szczepanek-arm
Copy link
Member

Summary of changes

This is purely documentation change. Help find ble events with crossreferences to functions.

Impact of changes

Migration actions required

Documentation

none

Pull request type 

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results 

[x] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

@paul-szczepanek-arm paul-szczepanek-arm requested a review from pan- June 23, 2021 12:29
@ciarmcom ciarmcom added the release-type: patch Indentifies a PR as containing just a patch label Jun 23, 2021
@ciarmcom ciarmcom requested a review from a team June 23, 2021 12:30
@ciarmcom
Copy link
Member

@paul-szczepanek-arm, thank you for your changes.
@ARMmbed/mbed-os-maintainers please review.

@ciarmcom
Copy link
Member

This pull request has automatically been marked as stale because it has had no recent activity. @pan-, @ARMmbed/mbed-os-maintainers, please complete review of the changes to move the PR forward. Thank you for your contributions.

@pan- pan- changed the title BLE: Clarify ble event docs with corssreferences BLE: Clarify ble event docs with crossreferences Jun 28, 2021
pan-
pan- previously approved these changes Jun 28, 2021
View reviewed changes
connectivity/FEATURE_BLE/include/ble/Gap.h Outdated
Comment on lines 415 to 417
* Called when connection attempt ends. Check event.getStatus() to see if connection
* was established. If this device is the peripheral and it as advertising this will
* end advertising which will also create the onAdvertisingEnd event.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Called when connection attempt ends. Check event.getStatus() to see if connection
* was established. If this device is the peripheral and it as advertising this will
* end advertising which will also create the onAdvertisingEnd event.
* Called when connection attempt ends. Check event.getStatus() to see if connection
* was established. If this device is the peripheral and it was advertising this will
* end the advertising set which will also create the onAdvertisingEnd event.

connectivity/FEATURE_BLE/include/ble/SecurityManager.h
@@ -264,6 +271,8 @@ class SecurityManager
*
* @param[in] connectionHandle connection connectionHandle
* @param[in] result result of the pairing indicating success or reason for failure
*
* @see acceptPairingRequest()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This related to requestPairing() too

connectivity/FEATURE_BLE/include/ble/Gap.h Outdated
@@ -431,8 +435,8 @@ class Gap {
*
* @version 4.1+.
*
* @note This event is not generated if connection parameters update
* is managed by the middleware.
* @note This event will only be produced if manageConnectionParametersUpdateRequest(true)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

manageConnectionParametersUpdateRequest(true) won't be cross referenced

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you address this ? I think This event will only be produced if manageConnectionParametersUpdateRequest() was called with true. would work. What do you think ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I misundestood, I though you meant the doc for manageConnectionParametersUpdateRequest isn't cross refed, so I added the @see over there.

connectivity/FEATURE_BLE/include/ble/SecurityManager.h Outdated
* calling the appropriate function: acceptPairingRequest or cancelPairingRequest
* Called when a pairing request is received. Application should respond by
* calling the appropriate function: acceptPairingRequest() or cancelPairingRequest().
* This event will only trigger if setPairingRequestAuthorisation(true) was called.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setPairingRequestAuthorisation(true) won't be cross referenced

@mergify mergify bot added needs: CI and removed needs: review labels Jun 28, 2021
0xc0170
0xc0170 previously approved these changes Jun 28, 2021
View reviewed changes
@paul-szczepanek-arm
Copy link
Member Author

Thanks, fixed.

@mergify mergify bot dismissed stale reviews from pan- and 0xc0170 June 28, 2021 15:34

Pull request has been modified.

@ciarmcom ciarmcom removed the stale Stale Pull Request label Jun 28, 2021
@0xc0170
Copy link
Contributor

0xc0170 commented Jun 29, 2021

CI started

@mbed-ci
Copy link

mbed-ci commented Jun 29, 2021

Jenkins CI Test : ✔️ SUCCESS

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs Status
jenkins-ci/mbed-os-ci_unittests ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_greentea-test ✔️

@0xc0170
Copy link
Contributor

0xc0170 commented Jun 29, 2021

@paul-szczepanek-arm Once ready for CI, let us know to start one.

@paul-szczepanek-arm
Copy link
Member Author

I'm done if @pan- says so.

@ciarmcom ciarmcom added the stale Stale Pull Request label Jun 30, 2021
@ciarmcom
Copy link
Member

This pull request has automatically been marked as stale because it has had no recent activity. @ARMmbed/mbed-os-maintainers, please start CI to get the PR merged.

@0xc0170
Copy link
Contributor

0xc0170 commented Jul 1, 2021

CI restarted

@mbed-ci
Copy link

mbed-ci commented Jul 1, 2021

Jenkins CI Test : ✔️ SUCCESS

Build Number: 2 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs Status
jenkins-ci/mbed-os-ci_unittests ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_build-example-ARM ✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM ✔️
jenkins-ci/mbed-os-ci_greentea-test ✔️

@mergify mergify bot removed the needs: CI label Jul 1, 2021
@0xc0170 0xc0170 merged commit d83494f into ARMmbed:master Jul 1, 2021
@mergify mergify bot removed ready for merge stale Stale Pull Request labels Jul 1, 2021
@mbedmain mbedmain added release-version: 6.13.0 Release-pending and removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pan- pan- pan- approved these changes

@0xc0170 0xc0170 0xc0170 left review comments

Assignees
No one assigned
Labels
component: connectivity release-version: 6.13.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@paul-szczepanek-arm @ciarmcom @0xc0170 @mbed-ci @pan- @mbedmain