1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00

refactor(videoframe): correct mistakes in commit documentation format

This commit is contained in:
initramfs 2016-08-01 16:00:21 +08:00
parent 8d3aef9269
commit 8ef89a267e
No known key found for this signature in database
GPG Key ID: 78B8BDF87E9EF0AF

View File

@ -36,9 +36,8 @@ extern "C"{
* *
* The creation of this structure was done to replace existing code which mis-used vpx_image * The creation of this structure was done to replace existing code which mis-used vpx_image
* structs when passing frame data to toxcore. * structs when passing frame data to toxcore.
*/ *
*
/**
* @class VideoFrame * @class VideoFrame
* @brief An ownernship and management class for AVFrames. * @brief An ownernship and management class for AVFrames.
* *
@ -57,19 +56,17 @@ extern "C"{
* *
* Frame alignment is an important concept because ToxAV does not support frames with linesizes not * Frame alignment is an important concept because ToxAV does not support frames with linesizes not
* directly equal to the width. * directly equal to the width.
*/ *
*
/**
* @var dataAlignment * @var dataAlignment
* @brief Data alignment parameter used to populate AVFrame buffers. * @brief Data alignment parameter used to populate AVFrame buffers.
* *
* This field is public in effort to standardized the data alignment parameter for all AVFrame * This field is public in effort to standardize the data alignment parameter for all AVFrame
* allocations. * allocations.
* *
* It's currently set to 32-byte alignment for AVX2 support. * It's currently set to 32-byte alignment for AVX2 support.
*/ *
*
/**
* @class FrameBufferKey * @class FrameBufferKey
* @brief A class representing a structure that stores frame properties to be used as the key * @brief A class representing a structure that stores frame properties to be used as the key
* value for a std::unordered_map. * value for a std::unordered_map.