component: fix doxygen args #9564
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cujomalainey
requested review from
lgirdwood,
plbossart,
mmaka1,
lbetlej,
dbaluta and
kv2019i
as code owners
kv2019i
approved these changes
Oct 10, 2024
| @@ -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 | |||
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
force of habit, every single module calls this arg spec in their implementation. I am going to update the signature to match that.
3rd is missing and config was incorrect. Rename 3rd arg in signature to match name most commonly used by implementers. Signed-off-by: Curtis Malainey <cujomalainey@chromium.org>
lgirdwood
approved these changes
Oct 15, 2024
lyakh
approved these changes
Oct 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Spec is missing and config was incorrect.