Skip to content

Commit afd9770

Browse files
author
Marcin Maka
committed
comp: fix api documentation formatting
Incorrect format of dox comments fixed. Added missing parameter documentation. Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
1 parent 32c5129 commit afd9770

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

src/include/sof/audio/component.h

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,16 @@ enum comp_endpoint_type {
208208
COMP_ENDPOINT_NODE /**< No dma connection */
209209
};
210210

211-
/* \brief Type of component copy, which can be changed on runtime */
211+
/**
212+
* \brief Type of next dma copy mode, changed on runtime.
213+
*
214+
* Supported by host as COMP_ATTR_COPY_TYPE parameter
215+
* to comp_set_attribute().
216+
*/
212217
enum comp_copy_type {
213-
COMP_COPY_NORMAL = 0,
214-
COMP_COPY_BLOCKING,
215-
COMP_COPY_ONE_SHOT,
218+
COMP_COPY_NORMAL = 0, /**< Normal */
219+
COMP_COPY_BLOCKING, /**< Blocking */
220+
COMP_COPY_ONE_SHOT, /**< One-shot */
216221
};
217222

218223
struct comp_driver;
@@ -292,15 +297,15 @@ struct comp_driver {
292297
struct comp_ops ops; /**< component operations */
293298
};
294299

295-
/* \brief Holds constant pointer to component driver */
300+
/** \brief Holds constant pointer to component driver */
296301
struct comp_driver_info {
297302
const struct comp_driver *drv; /**< pointer to component driver */
298303
struct list_item list; /**< list of component drivers */
299304
};
300305

301-
/* \brief Holds list of registered components' drivers */
306+
/** \brief Holds list of registered components' drivers */
302307
struct comp_driver_list {
303-
struct list_item list; /* list of component drivers */
308+
struct list_item list; /**< list of component drivers */
304309
};
305310

306311
/**
@@ -335,11 +340,10 @@ struct comp_dev {
335340
* across cores
336341
*/
337342

338-
/** common runtime configuration for downstream/upstream */
343+
/* common runtime configuration for downstream/upstream */
339344
uint32_t direction; /**< enum sof_ipc_stream_direction */
340345

341-
/** driver */
342-
const struct comp_driver *drv;
346+
const struct comp_driver *drv; /**< driver */
343347

344348
/* lists */
345349
struct list_item bsource_list; /**< list of source buffers */
@@ -595,6 +599,7 @@ static inline int comp_params(struct comp_dev *dev,
595599
* Fetch hardware stream parameters - only mandatory for DAI components.
596600
* @param dev Component device.
597601
* @param params hw parameters
602+
* @param dir Pipeline direction (see enum sof_ipc_stream_direction).
598603
* @return 0 if succeeded, error code otherwise.
599604
*/
600605
static inline int comp_dai_get_hw_params(struct comp_dev *dev,

0 commit comments

Comments
 (0)