Skip to content

Commit a7f8d54

Browse files
more doxygen
1 parent d3524e2 commit a7f8d54

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

features/FEATURE_BLE/ble/generic/SecurityDb.h

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -714,9 +714,36 @@ class SecurityDb {
714714
*/
715715
virtual void reset_entry(entry_handle_t db_handle) = 0;
716716

717+
/**
718+
* This will read in the requested information into a buffer that will remain valid
719+
* until another read_in call is made.
720+
* @param db_handle handle of the entry to be read
721+
* @return pointer to buffer holding the query result, NULL when not found
722+
*/
717723
virtual SecurityEntryIdentity_t* read_in_entry_peer_identity(entry_handle_t db_handle) = 0;
724+
725+
/**
726+
* This will read in the requested information into a buffer that will remain valid
727+
* until another read_in call is made.
728+
* @param db_handle handle of the entry to be read
729+
* @return pointer to buffer holding the query result, NULL when not found
730+
*/
718731
virtual SecurityEntryKeys_t* read_in_entry_peer_keys(entry_handle_t db_handle) = 0;
732+
733+
/**
734+
* This will read in the requested information into a buffer that will remain valid
735+
* until another read_in call is made.
736+
* @param db_handle handle of the entry to be read
737+
* @return pointer to buffer holding the query result, NULL when not found
738+
*/
719739
virtual SecurityEntryKeys_t* read_in_entry_local_keys(entry_handle_t db_handle) = 0;
740+
741+
/**
742+
* This will read in the requested information into a buffer that will remain valid
743+
* until another read_in call is made.
744+
* @param db_handle handle of the entry to be read
745+
* @return pointer to buffer holding the query result, NULL when not found
746+
*/
720747
virtual SecurityEntrySigning_t* read_in_entry_peer_signing(entry_handle_t db_handle) = 0;
721748

722749
protected:

0 commit comments

Comments
 (0)