From 124264032b5ab74efcd500a9b3e299fbe3ad3b45 Mon Sep 17 00:00:00 2001 From: Vivien Nicolas Date: Thu, 10 Feb 2022 18:37:41 +0100 Subject: [PATCH] [Documentation Warnings] Fix some documentations warnings (#15028) --- src/app/AttributePersistenceProvider.h | 2 +- src/app/CommandSender.h | 1 - src/app/EventManagement.h | 2 -- src/app/MessageDef/DataVersionFilterIB.h | 2 +- src/app/MessageDef/EventFilterIB.h | 2 +- src/app/MessageDef/ReadRequestMessage.h | 2 +- src/app/MessageDef/WriteRequestMessage.h | 2 +- src/app/ReadClient.h | 6 +++--- src/app/ReadHandler.h | 2 +- src/controller/CommissioneeDeviceProxy.h | 2 -- src/credentials/CHIPCert.h | 1 - src/credentials/DeviceAttestationVerifier.h | 4 ++-- src/transport/GroupSession.h | 2 +- src/transport/SessionDelegate.h | 2 -- src/transport/raw/Tuple.h | 2 +- 15 files changed, 13 insertions(+), 21 deletions(-) diff --git a/src/app/AttributePersistenceProvider.h b/src/app/AttributePersistenceProvider.h index 62f97a3dccfb59..95da7e96221733 100644 --- a/src/app/AttributePersistenceProvider.h +++ b/src/app/AttributePersistenceProvider.h @@ -87,7 +87,7 @@ AttributePersistenceProvider * GetAttributePersistenceProvider(); * * If the `provider` is nullptr, the value is not changed. * - * @param[in] provider the AttributePersistenceProvider implementation to use. + * @param[in] aProvider the AttributePersistenceProvider implementation to use. */ void SetAttributePersistenceProvider(AttributePersistenceProvider * aProvider); diff --git a/src/app/CommandSender.h b/src/app/CommandSender.h index 0e182bceaf5856..c2d4f025dba344 100644 --- a/src/app/CommandSender.h +++ b/src/app/CommandSender.h @@ -110,7 +110,6 @@ class CommandSender final : public Messaging::ExchangeDelegate * receives an OnDone call to destroy and free the object. * * @param[in] apCommandSender The command sender object that initiated the command transaction. - * @param[in] aStatusIB The status code including IM status code and optional cluster status code * @param[in] aError A system error code that conveys the overall error code. */ virtual void OnError(const CommandSender * apCommandSender, CHIP_ERROR aError) {} diff --git a/src/app/EventManagement.h b/src/app/EventManagement.h index 73ac7ee339dbc6..9daadfadc5f5e6 100644 --- a/src/app/EventManagement.h +++ b/src/app/EventManagement.h @@ -345,8 +345,6 @@ class EventManagement * @brief * Fetch the most recently vended Number for a particular priority level * - * @param aPriority Priority level - * * @return EventNumber most recently vended event Number for that event priority */ EventNumber GetLastEventNumber() { return mLastEventNumber; } diff --git a/src/app/MessageDef/DataVersionFilterIB.h b/src/app/MessageDef/DataVersionFilterIB.h index 761b21ac8be67c..f59be7c054ccf0 100644 --- a/src/app/MessageDef/DataVersionFilterIB.h +++ b/src/app/MessageDef/DataVersionFilterIB.h @@ -59,7 +59,7 @@ class Parser : public StructParser /** * @brief Get a TLVReader for the AttributePathIB. Next() must be called before accessing them. * - * @param [in] apClusterPath A pointer to apClusterPath + * @param [in] apPath A pointer to apPath * * @return #CHIP_NO_ERROR on success * #CHIP_ERROR_WRONG_TLV_TYPE if there is such element but it's not a Path diff --git a/src/app/MessageDef/EventFilterIB.h b/src/app/MessageDef/EventFilterIB.h index f0128133b781d3..7fbe26fc1c80d6 100644 --- a/src/app/MessageDef/EventFilterIB.h +++ b/src/app/MessageDef/EventFilterIB.h @@ -94,7 +94,7 @@ class Builder : public StructBuilder * * @return A reference to *this */ - EventFilterIB::Builder & Node(const NodeId aNode); + EventFilterIB::Builder & Node(const NodeId aNodeId); /** * @brief Inject EventId into the TLV stream. diff --git a/src/app/MessageDef/ReadRequestMessage.h b/src/app/MessageDef/ReadRequestMessage.h index 9b67b945cef3b0..07e46d9102e09a 100644 --- a/src/app/MessageDef/ReadRequestMessage.h +++ b/src/app/MessageDef/ReadRequestMessage.h @@ -82,7 +82,7 @@ class Parser : public MessageParser /** * @brief Get a TLVReader for the EventRequests. Next() must be called before accessing them. * - * @param [in] apEventPaths A pointer to apEventPaths + * @param [in] apEventRequests A pointer to apEventRequests * * @return #CHIP_NO_ERROR on success * #CHIP_END_OF_TLV if there is no such element diff --git a/src/app/MessageDef/WriteRequestMessage.h b/src/app/MessageDef/WriteRequestMessage.h index a914ab8546a64a..0e4ec4333ba3b3 100644 --- a/src/app/MessageDef/WriteRequestMessage.h +++ b/src/app/MessageDef/WriteRequestMessage.h @@ -122,7 +122,7 @@ class Builder : public MessageBuilder /** * @brief flag action as part of a timed write transaction - * @param [in] aSuppressResponse true if client need to signal suppress response + * @param [in] aTimedRequest true if client need to signal this is a timed request * @return A reference to *this */ WriteRequestMessage::Builder & TimedRequest(const bool aTimedRequest); diff --git a/src/app/ReadClient.h b/src/app/ReadClient.h index 53ed68effd44e6..24f731e82c6ec0 100644 --- a/src/app/ReadClient.h +++ b/src/app/ReadClient.h @@ -91,9 +91,9 @@ class ReadClient : public Messaging::ExchangeDelegate * This object MUST continue to exist after this call is completed. The application shall wait until it * receives an OnDone call to destroy the object. * - * @param[in] aEventHeader: The event header in report response. - * @param[in] apData: A TLVReader positioned right on the payload of the event. - * @param[in] apStatus: Event-specific status, containing an InteractionModel::Status code as well as an optional + * @param[in] aEventHeader The event header in report response. + * @param[in] apData A TLVReader positioned right on the payload of the event. + * @param[in] apStatus Event-specific status, containing an InteractionModel::Status code as well as an optional * cluster-specific status code. */ virtual void OnEventData(const EventHeader & aEventHeader, TLV::TLVReader * apData, const StatusIB * apStatus) {} diff --git a/src/app/ReadHandler.h b/src/app/ReadHandler.h index 13408faf02bba5..aae661fdd10ff2 100644 --- a/src/app/ReadHandler.h +++ b/src/app/ReadHandler.h @@ -121,7 +121,7 @@ class ReadHandler : public Messaging::ExchangeDelegate * @retval #CHIP_NO_ERROR On success. * */ - CHIP_ERROR SendReportData(System::PacketBufferHandle && aPayload, bool mMoreChunks); + CHIP_ERROR SendReportData(System::PacketBufferHandle && aPayload, bool aMoreChunks); /** * Returns whether this ReadHandler represents a subscription that was created by the other side of the provided exchange. diff --git a/src/controller/CommissioneeDeviceProxy.h b/src/controller/CommissioneeDeviceProxy.h index 6f21ba5025cacb..3352186cd8d0ae 100644 --- a/src/controller/CommissioneeDeviceProxy.h +++ b/src/controller/CommissioneeDeviceProxy.h @@ -156,8 +156,6 @@ class CommissioneeDeviceProxy : public DeviceProxy, public SessionReleaseDelegat * Called when the associated session is released * * The receiver should release all resources associated with the connection. - * - * @param session A handle to the secure session */ void OnSessionReleased() override; diff --git a/src/credentials/CHIPCert.h b/src/credentials/CHIPCert.h index ef722b7ff9c05d..3e3b576d07108e 100644 --- a/src/credentials/CHIPCert.h +++ b/src/credentials/CHIPCert.h @@ -665,7 +665,6 @@ CHIP_ERROR NewICAX509Cert(const X509CertRequestParams & requestParams, const Cry * @brief Generate a new X.509 DER encoded Node operational certificate * * @param requestParams Certificate request parameters. - * @param issuerLevel Indicates if the issuer is a root CA or an intermediate CA * @param subjectPubkey The public key of subject * @param issuerKeypair The certificate signing key * @param x509Cert Buffer to store signed certificate in X.509 DER format. diff --git a/src/credentials/DeviceAttestationVerifier.h b/src/credentials/DeviceAttestationVerifier.h index ae91633efbd615..e4a983e7386af7 100644 --- a/src/credentials/DeviceAttestationVerifier.h +++ b/src/credentials/DeviceAttestationVerifier.h @@ -134,7 +134,7 @@ class AttestationTrustStore * store that is both fully local and quick to access. * * @param[in] skid Buffer containing the subject key identifier (SKID) of the PAA to look-up - * @param[inout] outPaaDerBuffer Buffer to receive the contents of the PAA root cert, if found. + * @param[in,out] outPaaDerBuffer Buffer to receive the contents of the PAA root cert, if found. * Size will be updated to match actual size. * * @returns CHIP_NO_ERROR on success, CHIP_INVALID_ARGUMENT if `skid` or `outPaaDerBuffer` arguments @@ -235,7 +235,7 @@ class DeviceAttestationVerifier * * @param[in] certDeclBuffer A ByteSpan with the Certification Declaration content. * @param[in] firmwareInfo A ByteSpan with the Firmware Information content. - * @param[in] deviceInfo + * @param[in] deviceInfo The device information * * @returns AttestationVerificationResult::kSuccess on success or another specific * value from AttestationVerificationResult enum on failure. diff --git a/src/transport/GroupSession.h b/src/transport/GroupSession.h index 1b6a4bd51ed9d4..900efae2d23272 100644 --- a/src/transport/GroupSession.h +++ b/src/transport/GroupSession.h @@ -121,7 +121,7 @@ class GroupSessionTable /** * @brief Deletes an entry from the object pool * - * @param entry + * @param entry The GroupSession entry to delete */ void DeleteEntry(GroupSession * entry) { mEntries.ReleaseObject(entry); } diff --git a/src/transport/SessionDelegate.h b/src/transport/SessionDelegate.h index 97e1d66faa3ba1..162bc1f93c0531 100644 --- a/src/transport/SessionDelegate.h +++ b/src/transport/SessionDelegate.h @@ -28,8 +28,6 @@ class DLL_EXPORT SessionReleaseDelegate /** * @brief * Called when a session is releasing - * - * @param session The handle to the secure session */ virtual void OnSessionReleased() = 0; }; diff --git a/src/transport/raw/Tuple.h b/src/transport/raw/Tuple.h index f149c0dfde8871..3cd3b387909bf5 100644 --- a/src/transport/raw/Tuple.h +++ b/src/transport/raw/Tuple.h @@ -216,7 +216,7 @@ class Tuple : public Base * @tparam N the index of the underlying transport to run GroupJoinLeave through. * * @param address where to send the message - * @param msgBuf the message to send. Includes all CHIP message fields except optional length. + * @param join a boolean indicating if the transport should join or leave the group */ template ::type * = nullptr> CHIP_ERROR MulticastGroupJoinLeaveImpl(const Transport::PeerAddress & address, bool join)