Bluetooth: document bt_addr_le_is_resolved()

[alwa-nordic]

I believe there is some confusion about what this function does. This function is doing some type-bending, so it's extra important to document it.

[PavelVPV]

Would it be better to define an bt_hci_addr_le_t (or something) which can be just a redefine of bt_addr_le_t (this is not so important) and use type in those events as well as a type for an argument of this function?

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull Request Overview

This PR adds comprehensive documentation to the bt_addr_le_is_resolved() function to clarify its purpose and usage constraints. The function performs type inspection on HCI LE event address fields to determine if the Controller resolved a Resolvable Private Address (RPA).

Key Changes

• Added detailed documentation explaining the function's specific purpose for HCI LE event address inspection
• Clarified the critical distinction between HCI event address fields and regular application-layer bt_addr_le_t types
• Provided comprehensive list of HCI LE events that contain compatible address fields

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[PavelVPV]

Would it be better to define an bt_hci_addr_le_t (or something) which can be just a redefine of bt_addr_le_t (this is not so important) and use type in those events as well as a type for an argument of this function?

Will be done later.