Small doc editorial fixes after project-chip#19277

- Leftover comments follow-up in method docs
tcarmelveilleux · Jun 10, 2022 · b955f3a · b955f3a
1 parent 4e3930a
commit b955f3a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git 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
@@ -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
  */