From patchwork Sun Sep 25 00:10:27 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marvin Scholz X-Patchwork-Id: 34820 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:3b1c:b0:96:9ee8:5cfd with SMTP id c28csp1389598pzh; Sat, 24 Sep 2022 17:11:46 -0700 (PDT) X-Google-Smtp-Source: AMsMyM446Yy8eM5e8Yr6FpgCKAO8VnzoxaIs2CLNvmKKa5xjM/TwWY+LrTTIwSeEuRKMnHDetsAd X-Received: by 2002:a05:6402:26d4:b0:451:280d:3533 with SMTP id x20-20020a05640226d400b00451280d3533mr15536991edd.316.1664064706305; Sat, 24 Sep 2022 17:11:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664064706; cv=none; d=google.com; s=arc-20160816; b=VACNPcwnBgiVanif/hE/4QnqujNVgeXWy+J22wzaK3qXirWS9ladq8oEHZH6kTeCB1 unnNgLe4ugl/pZeWiaY0uojgznjNep76twmlF1egSZZZml3wMQLDnCInFaHnwdNoJ45M e9JJiD6nd3bI/b1ihCbEHia5oIQ5OtG0k64PJ3dSSvqGeUBBANTqlLtBgNUkIydUt1hW kACXAad332sMcniAXBzhI6h//n4wZ1xfFBl4HEKT3PDkexoIycgGiqdSQUNWdjX3rPGM Z94wRelv+cBkqQZE6120BZ2WWS/buZ8N5Liz5DUMnw5H+BJZWgBL7wYG+EScZwJgcPgt XyHQ== 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=nXcS1hCPkFHy5KfZ04KZ/2QoaHmwDNGxb1sXQNnZS7A=; b=IR132/wzCo3ctyHXqPdUIUe/y9ada9DCAgy0SRYEWP1USyLmOf1EwwcaYgb8OOXoc4 nydna/v/69961p7bOp+KHMWwkp+X08sdPgNYsgKDVYo4oNJCPSCscpyy5flnbEhwq1pC 9o+gkKwWajiG/T2nlFqOyoyKNI0OyEZUkPd95C3+kxWYTTqf9/zbqZhr3HjdWORWUssN abWX8NrNKscFRwLmY3C4e3IGmPkzrbp7AFpSkpsuMVrmMgR7li5adaLrm/JE0vukYCjj Jk2O3Jshwt3Bqz4j8Rbp55opKPDiB8vv/FJsI29nbV/DVNNlzaCnLSlTmbQ5mbgGaD6B kKwg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=hL6ODmOF; 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 sa27-20020a1709076d1b00b007825337afeesi8572825ejc.273.2022.09.24.17.11.45; Sat, 24 Sep 2022 17:11: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; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=hL6ODmOF; 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 4DBBD68BA90; Sun, 25 Sep 2022 03:11:43 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ej1-f45.google.com (mail-ej1-f45.google.com [209.85.218.45]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 5B48B68B357 for ; Sun, 25 Sep 2022 03:11:36 +0300 (EEST) Received: by mail-ej1-f45.google.com with SMTP id 13so7458391ejn.3 for ; Sat, 24 Sep 2022 17:11:36 -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=q0lyqG5rk124QVnsXP8TKBG3QQg/erLX5Lut9CemBdE=; b=hL6ODmOFcpU1c/XuIFfiLc6yidP3W6VPFXuiAwCrZExXomTLqTLi0CNMbVFEK5ht3k ms6fBtPN8uS4AaW9uoprSHLDC5RRSKhxqX6KTfpFleOI++mxEwlTCwrqM/8smTYF8v2g PWiEEyGhHtJDV/gDilyQxoIe7ZV24hBRp2OGojfXbuFVuXL8gGi0X51J33yj4K0shdnc eMLm2OJRmxkWf1BFIp+WqkOnliUVGLYMIMwOYVN5gOi7uo+/tuRJm73rgyhy1HHu6fOA itRa0pyp3bwOShdJXDpWgql368UqP1Jksw1+VY8d3KXJt7jhlawIVQRw+du48XqE7L/U IhAQ== 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=q0lyqG5rk124QVnsXP8TKBG3QQg/erLX5Lut9CemBdE=; b=KLWwF2U1b3ij7xg0Iuwrx+OyDSUXMoW3spO8B/5WEunxxF0O9vN3+D2xQVS9IuAmuv 8TADzjGtz4+ycK2rM47DO9WPY3O+s9vivGsStqhuUml6XpkGNdUkii52Imkb83y8cLdf uG2bFHWx3AwoDpjQVAdRF5Qde81t0xHfnxQxnQXSCPg8batPvp90qjMpo0KwFMPbF4C5 rqI62Qht20ve7d58mGLZ7DA4M91w1KojXub+XTOD1Ijm65ZGy/h6cWtQD4su9Y3ldAS+ m7RUeR1aHMmtWYWWZB/1uH98Q/ryDhTtzP9cw2rBHf4wKFTrGt3Nh9QU/fPsPWSykkMQ bF8g== X-Gm-Message-State: ACrzQf2itDB/bZnqgpRlrHfl/PBNE+FQ8wQpUmaNbHv6jkHpIC1wzdAR jFSl5D9jJ2lf0aublsvCk7xdqp1vXbg= X-Received: by 2002:a17:906:7007:b0:6ff:8028:42e with SMTP id n7-20020a170906700700b006ff8028042emr12718328ejj.278.1664064695585; Sat, 24 Sep 2022 17:11:35 -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.11.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 24 Sep 2022 17:11:35 -0700 (PDT) From: Marvin Scholz To: ffmpeg-devel@ffmpeg.org Date: Sun, 25 Sep 2022 02:10:27 +0200 Message-Id: <20220925001121.37721-1-epirat07@gmail.com> X-Mailer: git-send-email 2.37.0 (Apple Git-136) In-Reply-To: <20220922020400.46715-1-epirat07@gmail.com> References: <20220922020400.46715-1-epirat07@gmail.com> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes 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: Yhpe6yBw/OpM I've spent some more time to fix most of the issues and warnings reported by Doxygen. There are a few left, all undocumented arguments that were not immediately obvious to me what they do so I could not confidently document them. Changes since last version: - Use ///< in "Fix Doxygen trailing brief comments" - All patches after "avcodec/avcodec: Escape Doxygen reference" are new and were not in the previous set. Marvin Scholz (54): avcodec: Fix Doxygen trailing brief comments avdevice/avdevice: Fix mismatching argument name avformat/avformat: Fix mismatching argument names avutil: Fix mismatching argument names swresample/swresample: Fix mismatching argument names avformat/avformat: Improve doxy style avcodec/avcodec: Escape Doxygen reference avutil/channel_layout: Remove bogus closing group avutil/channel_layout: Move to its own group avutil/channel_layout: Group deprecated functions avutil/channel_layout: Group pre-defined channel layouts avutil/twofish: Fix doxy @param typo avcodec/vdpau: Fix doxy comment typo avcodec/codec_par: Add missing doxy group opening avcodec/videotoolbox: Add proper doxy group avutil/aes_ctr: Add proper doxy group avutil/display: consolidate group doxy avutil/display: Add file to doxy group avutil/spherical: consolidate group doxy avutil/spherical: Add file to doxy group avutil/stereo3d: consolidate group doxy avutil/stereo3d: Add file to doxy group avutil/csp: Fix bogus doxy filename swscale: Fix bogus doxy comment #ifdefs avcodec/mediacodec: use inline code for coderefs avcodec/mediacodec: link to related documentation doc/Doxyfile: Add FF_PAD_STRUCTURE to PREDEFINED avutil/bprint: Improve doxy documentation swresample: Fix Doxy reference to AVOptions avutil/camellia: Fix doxy @param typo avutil/channel_layout: Use inline code for Doxy avutil/channel_layout: Document missing arguments avfilter: Fix doxy references avformat/avio: Add doxy for missing argument avutil/detection_bbox: Add doxy for missing argument avutil/eval: Add doxy for missing arguments avutil/file: Add doxy for missing arguments avutil/lfg: Add doxy for missing argument avutil/lfg: Minor doxy improvements avutil/hwcontext: Add doxy for missing argument avutil/parseutils: Add doxy for missing arguments avutil/parseutils: Use inline code and properly escape avutil/uuid: Remove bogus doxy return doc avutil/rc4: Add doxy for missing arguments avutil/frame: Add doxy for missing argument avutil/avstring: Add doxy for missing argument avutil/des: Add doxy for missing arguments avutil/crc: Add doxy for missing arguments avutil/imgutils: document some missing arguments swscale: document some missing arguments avcodec/bsf: document missing arguments avutil/aes: document some missing arguments avutil/aes_ctr: document some missing arguments avutil/samplefmt: document missing argument doc/Doxyfile | 1 + libavcodec/avcodec.h | 10 +- libavcodec/bsf.h | 4 + libavcodec/codec_par.h | 9 +- libavcodec/mediacodec.h | 8 +- libavcodec/vdpau.h | 2 +- libavcodec/videotoolbox.h | 9 ++ libavdevice/avdevice.h | 2 +- libavfilter/avfilter.h | 21 +++-- libavformat/avformat.h | 182 +++++++++++++++++++++---------------- libavformat/avio.h | 1 + libavutil/aes.h | 7 +- libavutil/aes_ctr.h | 12 +++ libavutil/avstring.h | 1 + libavutil/bprint.h | 78 +++++++++++----- libavutil/camellia.h | 2 +- libavutil/channel_layout.h | 41 +++++++-- libavutil/crc.h | 3 + libavutil/csp.h | 7 +- libavutil/des.h | 8 +- libavutil/detection_bbox.h | 1 + libavutil/display.h | 14 +-- libavutil/eval.h | 5 + libavutil/file.h | 4 + libavutil/frame.h | 1 + libavutil/hwcontext.h | 3 +- libavutil/imgutils.h | 20 ++++ libavutil/lfg.h | 5 +- libavutil/mathematics.h | 6 +- libavutil/mem.h | 3 +- libavutil/parseutils.h | 24 +++-- libavutil/rational.h | 3 +- libavutil/rc4.h | 3 + libavutil/samplefmt.h | 1 + libavutil/spherical.h | 13 +-- libavutil/stereo3d.h | 16 ++-- libavutil/twofish.h | 2 +- libavutil/uuid.h | 1 - libswresample/swresample.h | 10 +- libswscale/swscale.h | 25 +++-- 40 files changed, 372 insertions(+), 196 deletions(-)