diff options
author | Timothy Gu <timothygu99@gmail.com> | 2014-07-04 22:06:45 +0400 |
---|---|---|
committer | Michael Niedermayer <michaelni@gmx.at> | 2014-07-05 00:07:23 +0400 |
commit | 3679edf429ebbd9eff48e9b410ca1cef7bdf158a (patch) | |
tree | d9222ae07231998c5a7a7dcb8760c1dcdcd3777a | |
parent | beed4ac1108a193f582598880d8cc6f59ba58a17 (diff) |
downmix_info: clarify doxygen
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
-rw-r--r-- | libavutil/downmix_info.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/libavutil/downmix_info.h b/libavutil/downmix_info.h index c369891c02..2fb9387a8d 100644 --- a/libavutil/downmix_info.h +++ b/libavutil/downmix_info.h @@ -95,11 +95,12 @@ typedef struct AVDownmixInfo { /** * Get a frame's AV_FRAME_DATA_DOWNMIX_INFO side data for editing. * - * The side data is created and added to the frame if it's absent. + * If the side data is absent, it is created and added to the frame. * - * @param frame the frame for which the side data is to be obtained. + * @param frame the frame for which the side data is to be obtained or created * - * @return the AVDownmixInfo structure to be edited by the caller. + * @return the AVDownmixInfo structure to be edited by the caller, or NULL if + * the sturcture cannot be allocated. */ AVDownmixInfo *av_downmix_info_update_side_data(AVFrame *frame); |