From patchwork Mon Aug 29 14:07:15 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anton Khirnov X-Patchwork-Id: 37558 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:139a:b0:8f:1db5:eae2 with SMTP id w26csp1967072pzh; Mon, 29 Aug 2022 07:07:47 -0700 (PDT) X-Google-Smtp-Source: AA6agR5FnS+nqUmsF3rCPmZPbRJ7bl+PQcAcBWw2hWlugGP8UKzRIzXnSIJk7i/1t3QIBnZ0ORBk X-Received: by 2002:a17:907:868b:b0:741:8f8c:6ab5 with SMTP id qa11-20020a170907868b00b007418f8c6ab5mr3535231ejc.194.1661782066904; Mon, 29 Aug 2022 07:07:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1661782066; cv=none; d=google.com; s=arc-20160816; b=M6ZQHbxB7mM/+vqPfp9rbP7Wkts3uCHfHELvbEKklqNc5Ne5rpILeemUA0W/jhnhXg HXzVythM7DXaYLhvYp0fcJ9XDN1GQUBNn5NTWXqfHEttyZc3lDR9aFOPJhWfUlJnBd0k o5/YKvqZLDn/5HGO7Mz8EiV9/rDC2DPksmxCBrrAWmOS7kmfnZuUV7IblZSC5q1ZWb8N Z5VX1qqab6x1iim0e1FVGFck/jsER68sRJK/QZ1LzIX7qEnbJvWqolDzDx9Zdq8C0JZr hrQN2BUHn6oTDp5+kCEGvGnICCB0nQxwJpsFoc+9fIzw9mEPF4XQovLfGF3I/ExRjk4R 4k4A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:reply-to:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:subject:mime-version:message-id:date:to:from :delivered-to; bh=siBkavPb55ksPDC3vKLvhOPo+4WaSauuTITuIyQZbFE=; b=vmy3uG+A69ZmPJqDuq18QaJtlfLCXh4O+nhXgeVQi5ynqGJNN9jZ1NmB9XOWU5R8ZI MJ7Nnc6lVfwTZGAI4dieJh5nCbvThJ2lyFPbB9bNTHtFANuZiWYNxLgGNMVrT2W4WB+I NRDlQv/szTv0KD4aJoHMxjotexM9smJxpXjCy/Hr1+Q1ypgVl3nHgkIU2RgrMbMhik8F xkj6zxsQgWcFKIQhOgswwfpaQsfvj37xQW3YMVPA3J5Tz7me2wDNLW0laH8yz6ELvQxe ZlZ/N6cuVEJWYCWqfZq5lGGr6oLPod46Y1tumXKiJzjgwZ6Iu7T8IpQ4TeKfz+j54NhL /66Q== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id ej15-20020a056402368f00b0044837598c6csi3854009edb.301.2022.08.29.07.07.46; Mon, 29 Aug 2022 07:07:46 -0700 (PDT) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id E360B68BA9A; Mon, 29 Aug 2022 17:07:33 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail0.khirnov.net (red.khirnov.net [176.97.15.12]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id C992268B9DD for ; Mon, 29 Aug 2022 17:07:26 +0300 (EEST) Received: from localhost (localhost [IPv6:::1]) by mail0.khirnov.net (Postfix) with ESMTP id 7A77F240D18 for ; Mon, 29 Aug 2022 16:07:26 +0200 (CEST) Received: from mail0.khirnov.net ([IPv6:::1]) by localhost (mail0.khirnov.net [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id yqrYxpQLUD-1 for ; Mon, 29 Aug 2022 16:07:26 +0200 (CEST) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:2a00:c500:561:201::7]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "libav.khirnov.net", Issuer "smtp.khirnov.net SMTP CA" (verified OK)) by mail0.khirnov.net (Postfix) with ESMTPS id 0A013240D0E for ; Mon, 29 Aug 2022 16:07:25 +0200 (CEST) Received: by libav.khirnov.net (Postfix, from userid 1000) id CF1D43A0ABF; Mon, 29 Aug 2022 16:07:18 +0200 (CEST) From: Anton Khirnov To: ffmpeg-devel@ffmpeg.org Date: Mon, 29 Aug 2022 16:07:15 +0200 Message-Id: <20220829140717.26557-1-anton@khirnov.net> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 1/3] lavu/fifo: add the header to its own doxy group X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 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" X-TUID: WWyc18vgXl7y Also, drop mentions of it being a circular buffer, as this is an internal implementation detail that should be invisible to the caller. --- libavutil/fifo.h | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/libavutil/fifo.h b/libavutil/fifo.h index 4eed364afc..6c6bd78842 100644 --- a/libavutil/fifo.h +++ b/libavutil/fifo.h @@ -18,7 +18,8 @@ /** * @file - * a very simple circular buffer FIFO implementation + * @ingroup lavu_fifo + * A generic FIFO API */ #ifndef AVUTIL_FIFO_H @@ -30,6 +31,14 @@ #include "attributes.h" #include "version.h" +/** + * @defgroup lavu_fifo AVFifo + * @ingroup lavu_data + * + * @{ + * A generic FIFO API + */ + typedef struct AVFifo AVFifo; /** @@ -423,4 +432,8 @@ static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs) #endif #endif +/** + * @} + */ + #endif /* AVUTIL_FIFO_H */