From b955f3aa24605b499b373ca9061e6dc4e6e8197a Mon Sep 17 00:00:00 2001 From: Tennessee Carmel-Veilleux Date: Fri, 10 Jun 2022 10:15:53 -0400 Subject: [PATCH] Small doc editorial fixes after #19277 - Leftover comments follow-up in method docs --- src/credentials/FabricTable.h | 4 ++-- src/crypto/OperationalKeystore.h | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/credentials/FabricTable.h b/src/credentials/FabricTable.h index 39e06dcaf1f794..6325ae5336dfac 100644 --- a/src/credentials/FabricTable.h +++ b/src/credentials/FabricTable.h @@ -189,7 +189,7 @@ class DLL_EXPORT FabricInfo // Validate an NOC chain at time of adding/updating a fabric (uses VerifyCredentials with additional checks). // The `existingFabricId` is passed for UpdateNOC, and must match the Fabric, to make sure that we are - // not trying to change FabricID with UpdateNOC. If set to kUndefinedFabricIndex, we are doing an add and + // not trying to change FabricID with UpdateNOC. If set to kUndefinedFabricId, we are doing AddNOC and // we don't need to check match to pre-existing fabric. static CHIP_ERROR ValidateIncomingNOCChain(const ByteSpan & noc, const ByteSpan & icac, const ByteSpan & rcac, FabricId existingFabricId, Credentials::CertificateValidityPolicy * policy, @@ -514,7 +514,7 @@ class DLL_EXPORT FabricTable * The keypair is temporary and becomes usable for `SignWithOpKeypair` only after either * `ActivatePendingOperationalKey` is called. It is destroyed if * `RevertPendingFabricData` is called before `CommitPendingFabricData`. - * If a pending keypair already existed, it is replaced by this call. + * If a pending keypair for the provided fabricIndex (if present) already existed, it is replaced by this call. * * Only one pending operational keypair is supported at a time. * diff --git a/src/crypto/OperationalKeystore.h b/src/crypto/OperationalKeystore.h index 5db98109547e87..29f13290d42f92 100644 --- a/src/crypto/OperationalKeystore.h +++ b/src/crypto/OperationalKeystore.h @@ -112,7 +112,7 @@ class OperationalKeystore * * @retval CHIP_NO_ERROR on success * @retval CHIP_ERROR_INCORRECT_STATE if the key store is not properly initialized. - * @retval CHIP_ERROR_INVALID_FABRIC_INDEX if there is no pending operational keypair for `fabricIndex` + * @retval CHIP_ERROR_INVALID_FABRIC_INDEX if there is no operational keypair for `fabricIndex` * @retval CHIP_ERROR_NOT_IMPLEMENTED if only `SignWithOpKeypair` is supported * @retval other CHIP_ERROR value on internal storage errors */