Skip to content

Commit cc799a8

Browse files
0xc01700xc0170
authored
Merge pull request #12661 from kbarm/feature-fix-documentation-ascii-art
Adjusted SecurityManager Doxygen ASCII art
2 parents 59540ed + a624acd commit cc799a8

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

‎features/FEATURE_BLE/ble/SecurityManager.h‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -124,19 +124,19 @@ namespace interface {
124124
* Sequence diagram "Just Works" pairing
125125
*
126126
* \verbatim
127-
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\
127+
* /-------- Device 1 ---------\ *----- BLE link -----* /----------- Device 2-----------\
128128
*
129-
* App EventHandler SecurityManager SecurityManager EventHandler App
130-
* | | | | | |
131-
* |---------------------------> requestPairing() | | |
132-
* | | |------[pairing start]------>| | |
133-
* | | | |----------------> pairingRequest() ->|
134-
* | | | acceptPairing() <------------------------ |
135-
* | | |<---[pairing complete]----->| | |
136-
* |<- pairingResult() <---------------| |----------------> pairingResult() -->|
137-
* | | | | | |
129+
* App EventHandler SecurityManager SecurityManager EventHandler App
130+
* | | | | | |
131+
* |-------------------> requestPairing() | | |
132+
* | | |-----[pairing start]----->| | |
133+
* | | | |---------> pairingRequest() -->|
134+
* | | | acceptPairing() <--------------------- |
135+
* | | |<--[pairing complete]---->| | |
136+
* |<- pairingResult() <-------| |---------> pairingResult() --->|
137+
* | | | | | |
138138
* @endverbatim
139-
*
139+
*
140140
* @note the requestPairing() call isn't required to trigger pairing. Pairing will also be triggered
141141
* if you request encryption and authentication and no bonding information is available. The sequence will
142142
* be the same save for the lack of explicit requestPairing() call.
@@ -145,44 +145,44 @@ namespace interface {
145145
* Sequence diagram Encryption request when bonding information is available
146146
*
147147
* \verbatim
148-
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\
148+
* /--------- Device 1 ---------\ *------ BLE link ------* /--------- Device 2 ---------\
149149
*
150-
* App EventHandler SecurityManager SecurityManager EventHandler App
151-
* | | | | | |
152-
* |---------------------------> setLinkEncryption() | | |
153-
* | | |<-[encryption established]->| | |
154-
* |<- linkEncryptionResult() <--------| |---------> linkEncryptionResult() -->|
155-
* | | | | | |
150+
* App EventHandler SecurityManager SecurityManager EventHandler App
151+
* | | | | | |
152+
* |--------------------> setLinkEncryption() | | |
153+
* | | |<-[encryption established]->| | |
154+
* |<- linkEncryptionResult() <-| |-> linkEncryptionResult() ->|
155+
* | | | | | |
156156
* @endverbatim
157-
*
157+
*
158158
* @note if bonding information is not available, pairing will be triggered
159159
*
160160
*
161161
* Sequence diagram for Secure Connections passkey entry pairing with one device having a display only
162162
* and other a keyboard
163163
*
164164
* \verbatim
165-
* /----------- Device 1 (keyboard) ---\ *------ BLE link ------* /-------------- Device 2 (display) ---\
165+
* /---- Device 1 (keyboard) ---\ *------ BLE link ------* /----- Device 2 (display) ---\
166166
*
167-
* App EventHandler SecurityManager SecurityManager EventHandler App
168-
* | | | | | |
169-
* |---------------------------> requestPairing() | | |
170-
* | | |------[pairing start]------>| | |
171-
* | | | |----------------> pairingRequest() ->|
172-
* | | | acceptPairing() <------------------------ |
173-
* | | |<---[secure con. pairing]-->| | |
174-
* |<- passkeyRequest() <--------------| |----------------> passkeyDisplay() ->|
175-
* | | | | | |
167+
* App EventHandler SecurityManager SecurityManager EventHandler App
168+
* | | | | | |
169+
* |--------------------> requestPairing() | | |
170+
* | | |------[pairing start]------>| | |
171+
* | | | |-------> pairingRequest() ->|
172+
* | | | acceptPairing() <--------------- |
173+
* | | |<---[secure con. pairing]-->| | |
174+
* |<- passkeyRequest() <-------| |-------> passkeyDisplay() ->|
175+
* | | | | | |
176176
*
177-
* user reads the passkey on Device 2 and inputs it on Device 1
177+
* user reads the passkey on Device 2 and inputs it on Device 1
178178
*
179-
* | | | | | |
180-
* |-------------------------->passkeyEntered() | | |
181-
* | | |<---[pairing complete]----->| | |
182-
* |<- pairingResult() <---------------| |----------------> pairingResult() -->|
183-
* | | | | | |
179+
* | | | | | |
180+
* |------------------->passkeyEntered() | | |
181+
* | | |<---[pairing complete]----->| | |
182+
* |<- pairingResult() <--------| |-------> pairingResult() -->|
183+
* | | | | | |
184184
* @endverbatim
185-
*
185+
*
186186
*/
187187
#if !defined(DOXYGEN_ONLY)
188188
template <class Impl>

0 commit comments

Comments
 (0)