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

Add [in] annotations to @param in chip-zcl-buffer.h as needed #897

Merged
merged 1 commit into from
May 28, 2020
Merged
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
16 changes: 8 additions & 8 deletions src/app/chip-zcl/chip-zcl-buffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ typedef struct
/**
* Function that allocates a buffer.
*
* @param allocatedLength the number of octets the resulting buffer should be
* able to store.
* @param[in] allocatedLength the number of octets the resulting buffer should
* be able to store.
* @return A newly allocated buffer. This should later be freed with
* chipZclBufferFree.
*/
Expand All @@ -71,16 +71,16 @@ ChipZclBuffer_t * chipZclBufferAlloc(uint16_t allocatedLength);
/**
* Function that returns a raw pointer to the underlying buffer.
*
* @param buffer the buffer we are working with.
* @param[in] buffer the buffer we are working with.
* @return A pointer to its underlying memory.
*/
uint8_t * chipZclBufferPointer(ChipZclBuffer_t * buffer);

/**
* Function that frees a buffer and its storage.
*
* @param buffer a buffer to free. The buffer should have been allocated with
* chipZclBufferAlloc.
* @param[in] buffer a buffer to free. The buffer should have been allocated
* with chipZclBufferAlloc.
*/
void chipZclBufferFree(ChipZclBuffer_t * buffer);

Expand All @@ -90,7 +90,7 @@ void chipZclBufferFree(ChipZclBuffer_t * buffer);
* After this call, the buffer is ready for reading or writing from the
* beginning again, depending on whether it was in reading more or writing mode.
*
* @param buffer the buffer to reset.
* @param[in] buffer the buffer to reset.
*/
void chipZclBufferReset(ChipZclBuffer_t * buffer);

Expand All @@ -99,15 +99,15 @@ void chipZclBufferReset(ChipZclBuffer_t * buffer);
* when the buffer is ready for reading. Always returns 0 for buffers that are
* being written to.
*
* @param buffer the buffer whose used length we want.
* @param[in] buffer the buffer whose used length we want.
* @return The number of bytes the given buffer holds.
*/
uint16_t chipZclBufferUsedLength(ChipZclBuffer_t * buffer);

/**
* Indicates that we are done writing to a buffer and prepares it for reading.
*
* @param buffer the buffer we are done writing to.
* @param[in] buffer the buffer we are done writing to.
*/
void chipZclBufferFinishWriting(ChipZclBuffer_t * buffer);

Expand Down