Audio: STFT Process: Fix doxygen syntax error #10455
Open
Conversation
This file contains hidden or 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
This patch fixes the documentation for function dft3_32(). Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
singalsu
requested review from
dbaluta,
kv2019i,
lbetlej,
lgirdwood,
mmaka1 and
plbossart
as code owners
There was a problem hiding this comment.
Pull request overview
This PR corrects the Doxygen documentation syntax for the dft3_32() function by updating parameter documentation from incorrect @x and @y tags to proper @param syntax, and renames the function parameters to match (input and output). Additionally, minor documentation improvements include capitalizing "E.g." and clarifying sentence structure.
- Updated Doxygen parameter documentation syntax from
@xand@yto@param inputand@param output - Renamed function parameters from
x_in/ytoinput/outputto align with documentation - Minor documentation clarity improvements (capitalization and wording)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lgirdwood
approved these changes
Dec 23, 2025
lyakh
approved these changes
Dec 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This patch fixes the documentation for function dft3_32().