[FFmpeg-devel] [PATCH] ffmpeg: better dox for *pts.

[Clément Bœsch]

On Wed, Feb 08, 2012 at 07:18:15PM +0100, Michael Niedermayer wrote:
> Signed-off-by: Michael Niedermayer <michaelni at gmx.at>
> ---
>  ffmpeg.c |    5 ++---
>  1 files changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/ffmpeg.c b/ffmpeg.c
> index d2cbd03..959a762 100644
> --- a/ffmpeg.c
> +++ b/ffmpeg.c
> @@ -210,9 +210,8 @@ typedef struct InputStream {
>      /* dts of the last packet read for this stream */
>      int64_t       dts;
>  
> -    int64_t       next_pts;  /* synthetic pts for cases where pkt.pts
> -                                is not defined */
> -    int64_t       pts;       /* current pts */
> +    int64_t       next_pts;  /**< synthetic pts for the next decode frame */
> +    int64_t       pts;       /**< current pts of the decoded frame */

"/**< ... */" form is mainly for multiline comments AFAICT (and the '<' is
pointing on the field it is related to avoid confusion). If the comment is
inlined you can use simply use "///< ...".

[...]

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20120208/f3645881/attachment.asc>