From patchwork Sat Jan 12 23:15:55 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicolas Granger X-Patchwork-Id: 11720 Return-Path: X-Original-To: patchwork@ffaux-bg.ffmpeg.org Delivered-To: patchwork@ffaux-bg.ffmpeg.org Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by ffaux.localdomain (Postfix) with ESMTP id CDAFA44E12D for ; Sun, 13 Jan 2019 01:25:48 +0200 (EET) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id ED7AE68A596; Sun, 13 Jan 2019 01:25:36 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-wr1-f43.google.com (mail-wr1-f43.google.com [209.85.221.43]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 6A3E668A55B for ; Sun, 13 Jan 2019 01:25:30 +0200 (EET) Received: by mail-wr1-f43.google.com with SMTP id t6so18878925wrr.12 for ; Sat, 12 Jan 2019 15:25:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:subject:to:message-id:date:user-agent:mime-version :content-language:content-transfer-encoding; bh=RFlad8oEmOK4pJmX77Zyeqz7/c3F/HtrEbieJ2M8NCg=; b=jSnaYJkqm3F6C3ahxvaraC2UobYDzF5Q0f3bcZqRPBEEWQE0bRRx1zr1PK2t6wH2jx Sd+eFioALbD8tCLnQgZPgxJ9K7lwLKYGi5tbPeUE59DLxlVUvOWMalOoezHOHzclB8d3 4TOH7HPhYnmONAYq3HHdTICpB8wTSjHn6ERW2J3H7mTl5yclEFQy0IugeqMB9iULfywM IhXnWRIbb0IY03Vobjy8gXwjG6Z51P5qJS5Wj6FgXcAHpZ9b2zdzUj6U0YJm6Apa8pCW UmWPfVKRnH5CBQUccWRrSJWsMaW5Tw5Cub5GFZWaRkC/MTRnYVPnLVFLXP+S+BdqJNCY yPhQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:subject:to:message-id:date:user-agent :mime-version:content-language:content-transfer-encoding; bh=RFlad8oEmOK4pJmX77Zyeqz7/c3F/HtrEbieJ2M8NCg=; b=YrFHna3u/t9hwvJB3vpTujNBwLA7jBchpR4mQ+ZPcOPOqWUrxwFT/Q1oryXPLw+aD7 nM4qESp2D+Ie86ytmK3qsJpHXuUKMo+5LT6QetfMvi+nnZPXVpnrDGHEr+bQ/uX30DcR lzxsYroChVSwemvBMX4dQ5Du1lQyUyeHNCiuJO9mA70k8CSbAz1ZmoUKWwMpZGt8YtbI p1Sgl0GhzOFCB+f9ExoXF4ocwLB460iROQUIObw5dhZ9UKsoKjQTCdRHAvMk6G2iyXI2 /98FjKMrMMti+npjNJhw6267CTN73ksObBy55HV/8ZF9sRDVB7g28X0Xm3rzVq/+L8aB rKeg== X-Gm-Message-State: AJcUukcfbUn6MP4yyzNCLAR8+CiZUnmQoUdsszl/SNG+iaSo6syqmEzu Jp82sLOwDEdLfebFw6yLObjEg6gs X-Google-Smtp-Source: ALg8bN4vJPuIcfD7ec/3MH4335SkddJ/pekbvsr+bGSn/1WjUjbm0fUnA1pNP+R72eFW/WFzsqpRSQ== X-Received: by 2002:adf:ee46:: with SMTP id w6mr19332430wro.261.1547335086770; Sat, 12 Jan 2019 15:18:06 -0800 (PST) Received: from [192.168.1.41] (lfbn-1-12739-6.w90-90.abo.wanadoo.fr. [90.90.43.6]) by smtp.gmail.com with ESMTPSA id a18sm82985143wrp.13.2019.01.12.15.18.05 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sat, 12 Jan 2019 15:18:06 -0800 (PST) From: Nicolas Granger To: ffmpeg-devel@ffmpeg.org Message-ID: <7374523f-f697-50ec-b199-6387d7d6a38c@gmail.com> Date: Sun, 13 Jan 2019 00:15:55 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.4.0 MIME-Version: 1.0 Content-Language: en-US-large Subject: [FFmpeg-devel] [PATCH] avcodec: fix some docstrings X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Hello, This fixes an erroneous reference and missing links in the API documentation. Best regards, Nicolas Granger --- libavcodec/avcodec.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index 4414853e84..64ba039be2 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -4892,7 +4892,8 @@ int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt); * @param frame This will be set to a reference-counted video or audio * frame (depending on the decoder type) allocated by the * decoder. Note that the function will always call - * av_frame_unref(frame) before doing anything else. + * @ref av_frame_unref "av_frame_unref(frame)" before doing + * anything else. * * @return * 0: success, a frame was returned @@ -4948,7 +4949,8 @@ int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame); * @param avctx codec context * @param avpkt This will be set to a reference-counted packet allocated by the * encoder. Note that the function will always call - * av_frame_unref(frame) before doing anything else. + * @ref av_packet_unref "av_packet_unref(avpkt)" before doing + * anything else. * @return 0 on success, otherwise negative error code: * AVERROR(EAGAIN): output is not available in the current state - user * must try to send input