[Warnings] Update the documentation of some files in src/app and src/…

…protocols to avoid some warnings when compiling with XCode (#11626)
project-chip · Nov 11, 2021 · a7d17ac · a7d17ac
1 parent aa7f89c
commit a7d17ac
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 7 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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;