Skip to content

component: fix doxygen args #9564

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.

Sign up for GitHub

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

Merged
lgirdwood merged 1 commit into from
Oct 16, 2024
Merged

component: fix doxygen args #9564

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions src/include/sof/audio/component.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,8 @@ struct comp_ops {
/**
* Creates a new component device.
* @param drv Parent component driver.
* @param comp Component parameters.
* @param ipc_config Component parameters.
* @param spec Pointer to initialization data
Copy link
Collaborator

@kv2019i kv2019i Oct 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was expecting parameter-name to match the C signature (i.e. "ipc_specific_config"), but I guess it doesn't matter (either to doxygen or the person consuming the docs).

Copy link
Contributor Author

@cujomalainey cujomalainey Oct 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

force of habit, every single module calls this arg spec in their implementation. I am going to update the signature to match that.

* @return Pointer to the new component device.
*
* All required data objects should be allocated from the run-time
Expand All @@ -295,7 +296,7 @@ struct comp_ops {
*/
struct comp_dev *(*create)(const struct comp_driver *drv,
const struct comp_ipc_config *ipc_config,
const void *ipc_specific_config);
const void *spec);

/**
* Called to delete the specified component device.
Expand Down