Bluetooth: Audio: Fix bad docs for codec helper functions #81799
+272
−271
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
Several of the codec helper functions used @RetVal incorrectly Several functions referenced @ccid_list incorrectly Signed-off-by: Emil Gydesen <[email protected]>
kartben
requested changes
Nov 23, 2024
| @@ -845,9 +845,9 @@ int bt_audio_codec_cfg_freq_hz_to_freq(uint32_t freq_hz); | |||
| * @param codec_cfg The codec configuration to extract data from. | |||
| * | |||
| * @retval A @ref bt_audio_codec_cfg_freq value | |||
| @@ -890,9 +890,9 @@ int bt_audio_codec_cfg_frame_dur_us_to_frame_dur(uint32_t frame_dur_us); | |||
| * @param codec_cfg The codec configuration to extract data from. | |||
| * | |||
| * @retval A @ref bt_audio_codec_cfg_frame_dur value | |||
| * @retval -EINVAL if arguments are invalid. | ||
| * @retval The converted frequency value in Hz. | ||
| * @retval -EINVAL Arguments are invalid. | ||
| * @retval frequency The converted frequency value in Hz. |
There was a problem hiding this comment.
You want this one listed first I think, i.e. the most likely return value first (applies throughout the PR)
Related, and since we don't have guidelines just yet and I very much value your thoughts on this topic and the fact we can use this PR as a way to settle on best practices for documenting return values, how about the "non-distinctive" value be described using @return? Basically, this: https://docs.rtems.org/branches/master/eng/coding-doxygen.html#function-declarations
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.
Several of the codec helper functions used @RetVal incorrectly Several functions referenced @ccid_list incorrectly