Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation Warnings] Fix some documentations warnings #15028

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/app/AttributePersistenceProvider.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
1 change: 0 additions & 1 deletion src/app/CommandSender.h
Original file line number Diff line number Diff line change
Expand Up @@ -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) {}
Expand Down
2 changes: 0 additions & 2 deletions src/app/EventManagement.h
Original file line number Diff line number Diff line change
Expand Up @@ -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; }
Expand Down
2 changes: 1 addition & 1 deletion src/app/MessageDef/DataVersionFilterIB.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/MessageDef/EventFilterIB.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/app/MessageDef/ReadRequestMessage.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/MessageDef/WriteRequestMessage.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
6 changes: 3 additions & 3 deletions src/app/ReadClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -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) {}
Expand Down
2 changes: 1 addition & 1 deletion src/app/ReadHandler.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions src/controller/CommissioneeDeviceProxy.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
1 change: 0 additions & 1 deletion src/credentials/CHIPCert.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/credentials/DeviceAttestationVerifier.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/transport/GroupSession.h
Original file line number Diff line number Diff line change
Expand Up @@ -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); }

Expand Down
2 changes: 0 additions & 2 deletions src/transport/SessionDelegate.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};
Expand Down
2 changes: 1 addition & 1 deletion src/transport/raw/Tuple.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 <size_t N, typename std::enable_if<(N < sizeof...(TransportTypes))>::type * = nullptr>
CHIP_ERROR MulticastGroupJoinLeaveImpl(const Transport::PeerAddress & address, bool join)
Expand Down