From patchwork Sun Sep 25 00:11:06 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marvin Scholz X-Patchwork-Id: 38249 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:3b1c:b0:96:9ee8:5cfd with SMTP id c28csp1391984pzh; Sat, 24 Sep 2022 17:17:25 -0700 (PDT) X-Google-Smtp-Source: AMsMyM4zcrMYPBVCDhP+uDSW0SrZSsnjyMGh4RTivopzy6crr51D8j0t7+NT3IgxGoj7ah+5+x8r X-Received: by 2002:a17:907:a4c:b0:77b:ba98:d3e with SMTP id be12-20020a1709070a4c00b0077bba980d3emr13133340ejc.13.1664065044966; Sat, 24 Sep 2022 17:17:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664065044; cv=none; d=google.com; s=arc-20160816; b=WtFnsxKyLnuJYxAuKpRDzhiBKo/m3Ad4AgxoI01SNFlbjDXzcEeaI/NYCdBfh9kR8r DGaAwGutqR4IfJNzdScDnLEHKhOvgCUeiZMFGsZY4jEPHCyBLPZxr6J6Dd+Ds7nupbn4 ykijE+25zR5hsllQhVekz/IwxkM5KpJmLOZi+j283+M39MJmz+JLmYfQhsIuPxKsENTl kkpGd+3lGIO+lwyYpGOw+zuADwJgaZh85kU3+kgwlEwGH7qH0JS2ZylgHEU0AU2rmewP zGk+YotKcUZUd3inFKbfAJzCxOv95LdQr8ah2LVL12Y5nQy57xRIyHyG0UU0dnukRdkZ JMUQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:cc:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature:delivered-to; bh=i2VGkE3r20YJ6z41c8310nVa4jazng6xvagnYxbS9CE=; b=n2ERz49dVAjljuSubSQpv58IOpnfCxE6TXAO4OvZQF2uVvTA7Nw2qNpwOZuVWT52N9 SwQDi0K/8NeAS4Te2l/Ged+/YOaijSGTa3yUlktCale0pw3mzyxAW5Lluqh/0Cp5tdyO /nWN/jNJuKDinXeobJb1Q0N3yZHTfNsj4LOC0fK3DoIqm2YfRggi3KTzb11eXkUta8KF KPeUpvjYCcghv8Aecrx7rl1TmOOaO9dNnyLpBDn48AsYTAZpe52jxnXH2zPG4Q0BHVXU xFPwgFZzJXzxAgOlYVHQz6Q4rbbec/HMCMM4NSKid+UpRxAtBgkI7oqgR/LB4nGMWtq1 sf5g== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=IO9x2+NK; 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; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id dn18-20020a17090794d200b00782b261ea21si5152298ejc.729.2022.09.24.17.17.24; Sat, 24 Sep 2022 17:17:24 -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; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=IO9x2+NK; 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; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 6D7E968BC33; Sun, 25 Sep 2022 03:12:25 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ej1-f46.google.com (mail-ej1-f46.google.com [209.85.218.46]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 75FE968BBCE for ; Sun, 25 Sep 2022 03:12:22 +0300 (EEST) Received: by mail-ej1-f46.google.com with SMTP id sd10so7480801ejc.2 for ; Sat, 24 Sep 2022 17:12:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date; bh=c5e9QH4Fj27jS3cSXCP4LF6MkBMeI8An3HKrcCblfIw=; b=IO9x2+NKhSxcsmKyCiLN5A+zSW8L3X1Jej1XdJYs1XY5aRYG4566kdju9o3WpAuFX4 XRfSWnBpCRYaTVocej7r0y02FazR8NdJZ+8q6Qo+83slCRQ8y+uKODYi1IUkLGsQ9amQ Z7PWQMPRnT3OWwyFunO0GBcqNatz66SVD9NAL3voFA20R2yVgQwe7z6hgJ5LD3TTrveO cFpAbWuPTzjn7BfV5f5NyHBjpkAPoCqT7LDYoIgFQJ/XJNQDHlEYEiIEJcxm0ztSIYcq DjgleNSWTLmwTWVVYB0g4NsNbfV2g6lNnnKRyO+2sWTOVdtUYX0d/5c7VN74vEwy6Did 6POQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date; bh=c5e9QH4Fj27jS3cSXCP4LF6MkBMeI8An3HKrcCblfIw=; b=r9hrrtdT1uzUtWLE+xsi2t/W6QcteEh98WQ9M+sCgMTBrYWdw4JSPomKvhHoyCSV6f 9wgayTErEKdgp+hLMcke8x6T2El6MH67S1gtM0ARWb+Iy+QEYzLxUQ8DpUS4oT3xPEHM cOoMfhPrptrk99iwpr1pZlY3y+TXqguPWimHFC6n9VxriTvgIjoFv5k/3wrWSezmmuwg CxkThU+uyPti4h82+/aimhsNYbHb+LTdrhK0DKu/9hLvHomYeh837x6n4rMT7KJzyCrO s/50NmXqG7SYEy7fF0HrO5h/VQ/pSM8PnVskirLjGJ9ePqdLKgClLZrRKDVZhiKMfcwb WGCQ== X-Gm-Message-State: ACrzQf0gB8TRD1GMZ5peirElWGTVLzVedX2FKQtUO86Wo+VMMeev5Tb6 dveVMtnn5odwO4egNRi23BpztSWwFDA= X-Received: by 2002:a17:907:b04:b0:780:32ea:4fe with SMTP id h4-20020a1709070b0400b0078032ea04femr12501649ejl.452.1664064742174; Sat, 24 Sep 2022 17:12:22 -0700 (PDT) Received: from MBP-von-Marvin.citadel.scalie.me (84-112-104-25.cable.dynamic.surfer.at. [84.112.104.25]) by smtp.gmail.com with ESMTPSA id kz3-20020a17090777c300b007812ba2a360sm6208042ejc.149.2022.09.24.17.12.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 24 Sep 2022 17:12:21 -0700 (PDT) From: Marvin Scholz To: ffmpeg-devel@ffmpeg.org Date: Sun, 25 Sep 2022 02:11:06 +0200 Message-Id: <20220925001121.37721-40-epirat07@gmail.com> X-Mailer: git-send-email 2.37.0 (Apple Git-136) In-Reply-To: <20220925001121.37721-1-epirat07@gmail.com> References: <20220922020400.46715-1-epirat07@gmail.com> <20220925001121.37721-1-epirat07@gmail.com> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH v3 39/54] avutil/lfg: Minor doxy improvements 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 Cc: Marvin Scholz Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: 7izrWcIodOcB Use inline code for sizeof and use proper @return directive. --- libavutil/lfg.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libavutil/lfg.h b/libavutil/lfg.h index 16917827c6..e75a986f12 100644 --- a/libavutil/lfg.h +++ b/libavutil/lfg.h @@ -27,7 +27,7 @@ /** * Context structure for the Lagged Fibonacci PRNG. * The exact layout, types and content of this struct may change and should - * not be accessed directly. Only its sizeof() is guaranteed to stay the same + * not be accessed directly. Only its `sizeof()` is guaranteed to stay the same * to allow easy instanciation. */ typedef struct AVLFG { @@ -40,7 +40,7 @@ void av_lfg_init(AVLFG *c, unsigned int seed); /** * Seed the state of the ALFG using binary data. * - * Return value: 0 on success, negative value (AVERROR) on failure. + * @return 0 on success, negative value (AVERROR) on failure. */ int av_lfg_init_from_data(AVLFG *c, const uint8_t *data, unsigned int length);