comp: improve comp_get_copy_limits documentation

Original description rephrased to provide better information about function commonly used by component developers. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
iganakov · Apr 7, 2020 · f00c445 · f00c445
1 parent 5b99262
commit f00c445
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/src/include/sof/audio/component.h b/src/include/sof/audio/component.h
@@ -682,10 +682,13 @@ static inline void comp_overrun(struct comp_dev *dev, struct comp_buffer *sink,
 /** @}*/
 
 /**
- * Called by component in copy.
- * @param source Source buffer.
- * @param sink Sink buffer.
- * @param cl Struct of parameters for use in copy function.
+ * Computes source to sink copy operation boundaries including maximum number
+ * of frames that can be transferred (data available in source vs. free space
+ * available in sink).
+ *
+ * @param[in] source Source buffer.
+ * @param[in] sink Sink buffer.
+ * @param[out] cl Current copy limits.
  */
 void comp_get_copy_limits(struct comp_buffer *source, struct comp_buffer *sink,
 			  struct comp_copy_limits *cl);