Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
connectedhomeip
Manage
Activity
Members
Plan
Wiki
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
CodeLinaro
qsdk
connectedhomeip
Commits
ab814a9a
Unverified
Commit
ab814a9a
authored
4 years ago
by
Boris Zbarsky
Committed by
GitHub
4 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Add [in] annotations to @param in chip-zcl-buffer.h as needed (#897)
parent
3425be32
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/app/chip-zcl/chip-zcl-buffer.h
+8
-8
8 additions, 8 deletions
src/app/chip-zcl/chip-zcl-buffer.h
with
8 additions
and
8 deletions
src/app/chip-zcl/chip-zcl-buffer.h
+
8
−
8
View file @
ab814a9a
...
...
@@ -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.
*/
...
...
@@ -71,7 +71,7 @@ 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
);
...
...
@@ -79,8 +79,8 @@ 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
);
...
...
@@ -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
);
...
...
@@ -99,7 +99,7 @@ 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
);
...
...
@@ -107,7 +107,7 @@ 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
);
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment