From a7d17acd5dbb43ca5ba687d88de3dd1fd277a886 Mon Sep 17 00:00:00 2001 From: Vivien Nicolas Date: Thu, 11 Nov 2021 17:53:12 +0100 Subject: [PATCH] [Warnings] Update the documentation of some files in src/app and src/protocols to avoid some warnings when compiling with XCode (#11626) --- src/app/CommandSender.h | 2 +- src/app/InteractionModelEngine.h | 4 +--- src/app/MessageDef/EventPathIB.h | 2 +- src/protocols/user_directed_commissioning/UDCClients.h | 2 +- .../user_directed_commissioning/UserDirectedCommissioning.h | 2 +- 5 files changed, 5 insertions(+), 7 deletions(-) diff --git a/src/app/CommandSender.h b/src/app/CommandSender.h index f582a9fce97b68..ef52837c19ac06 100644 --- a/src/app/CommandSender.h +++ b/src/app/CommandSender.h @@ -69,7 +69,7 @@ class CommandSender final : public Command, public Messaging::ExchangeDelegate * @param[in] aStatusIB It will always have a success status. If apData is null, it can be any success status, * including possibly a cluster-specific one. If apData is not null it aStatusIB will always * be a generic SUCCESS status with no-cluster specific information. - * @param[in] aData The command data, will be nullptr if the server returns a StatusIB. + * @param[in] apData The command data, will be nullptr if the server returns a StatusIB. */ virtual void OnResponse(CommandSender * apCommandSender, const ConcreteCommandPath & aPath, const StatusIB & aStatusIB, TLV::TLVReader * apData) diff --git a/src/app/InteractionModelEngine.h b/src/app/InteractionModelEngine.h index d5fce192f6e56a..ccb8bbd009ca40 100644 --- a/src/app/InteractionModelEngine.h +++ b/src/app/InteractionModelEngine.h @@ -151,9 +151,7 @@ class InteractionModelEngine : public Messaging::ExchangeDelegate, public Comman * on successful completion of this function. On failure, it will be updated to point to * nullptr. * @param[in] aInteractionType Type of interaction (read or subscription) that the requested ReadClient should execute. - * @param[in] aAppIdentifier A unique token that can be attached to the returned ReadClient object that will be - * passed through some of the methods in the registered InteractionModelDelegate. - * @param[in] apDelegateOverride If not-null, permits overriding the default delegate registered with the + * @param[in] aCallback If not-null, permits overriding the default delegate registered with the * InteractionModelEngine that will be used by the ReadClient. * * @retval #CHIP_ERROR_INCORRECT_STATE If there is no ReadClient available diff --git a/src/app/MessageDef/EventPathIB.h b/src/app/MessageDef/EventPathIB.h index 95cc79c9cffcda..25c6893c58c190 100644 --- a/src/app/MessageDef/EventPathIB.h +++ b/src/app/MessageDef/EventPathIB.h @@ -112,7 +112,7 @@ class Parser : public ListParser /** * @brief Get a TLVReader for the bool isUrgent. Next() must be called before accessing them. * - * @param [in] apISUrgent A pointer to apIsUrgent + * @param [in] apIsUrgent A pointer to apIsUrgent * * @return #CHIP_NO_ERROR on success * #CHIP_ERROR_WRONG_TLV_TYPE if there is such element but it's not any of the defined unsigned integer types diff --git a/src/protocols/user_directed_commissioning/UDCClients.h b/src/protocols/user_directed_commissioning/UDCClients.h index bf119fe0588ebd..be7ef25b3962a1 100644 --- a/src/protocols/user_directed_commissioning/UDCClients.h +++ b/src/protocols/user_directed_commissioning/UDCClients.h @@ -87,7 +87,7 @@ class UDCClients /** * Get a UDC Client state given a Peer address. * - * @param address is the connection to find (based on address) + * @param index is the index of the connection to find * * @return the state found, nullptr if not found */ diff --git a/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h b/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h index d7750f6c5cb027..e946b9acdb5370 100644 --- a/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h +++ b/src/protocols/user_directed_commissioning/UserDirectedCommissioning.h @@ -79,7 +79,7 @@ class DLL_EXPORT UserConfirmationProvider * commission the given node, and obtain the setup code to allow commissioning to proceed, * and then invoke commissioning on the given Node (using CHIP Device Controller, for example) * - * @param nodeData DNS-SD node information for the client requesting commissioning + * @param[in] state The state for the UDC Client. * */ virtual void OnUserDirectedCommissioningRequest(UDCClientState state) = 0;