diff options
author | Stefano Sabatini <stefasab@gmail.com> | 2023-01-15 02:57:14 +0100 |
---|---|---|
committer | Stefano Sabatini <stefasab@gmail.com> | 2023-02-11 17:49:01 +0100 |
commit | 34ff361921ef3698d18626a7b7e1e9a48821c69a (patch) | |
tree | e3ebaa1f074f747dc02d843108a4825701b3bc11 /doc/examples/vaapi_encode.c | |
parent | 3d4dc6aa778e60073f608d379139b46051da2302 (diff) | |
download | ffmpeg-34ff361921ef3698d18626a7b7e1e9a48821c69a.tar.gz |
examples: apply doxy entries consistency fixes
Use consistent format for the @file field and file description.
Diffstat (limited to 'doc/examples/vaapi_encode.c')
-rw-r--r-- | doc/examples/vaapi_encode.c | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/doc/examples/vaapi_encode.c b/doc/examples/vaapi_encode.c index e232fa579a..d5f472f6dd 100644 --- a/doc/examples/vaapi_encode.c +++ b/doc/examples/vaapi_encode.c @@ -1,6 +1,4 @@ /* - * Video Acceleration API (video encoding) encode sample - * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights @@ -21,13 +19,12 @@ */ /** - * @file - * Intel VAAPI-accelerated encoding example. - * + * @file Intel VAAPI-accelerated encoding API usage example * @example vaapi_encode.c - * This example shows how to do VAAPI-accelerated encoding. now only support NV12 - * raw file, usage like: vaapi_encode 1920 1080 input.yuv output.h264 * + * Perform VAAPI-accelerated encoding. Read input from an NV12 raw + * file, and write the H.264 encoded data to an output raw file. + * Usage: vaapi_encode 1920 1080 input.yuv output.h264 */ #include <stdio.h> |