[{"id":17977,"web_url":"https://patchwork.libcamera.org/comment/17977/","msgid":"","date":"2021-07-05T11:22:00","subject":"Re: [libcamera-devel] [PATCH] libcamera: transform: Document\n\tTransform enumerators as such","submitter":{"id":42,"url":"https://patchwork.libcamera.org/api/people/42/","name":"David Plowman","email":"david.plowman@raspberrypi.com"},"content":"Hi Laurent\n\nThanks for fixing this, I remember scratching my head over it at the\ntime. I'm glad Doxygen have finally sorted out the problem!\n\nOn Sun, 4 Jul 2021 at 14:06, Laurent Pinchart\n wrote:\n>\n> Due to a bug in Doxygen that didn't properly handle enum class\n> enumerators when defined in a namespace, the Transform enumerators were\n> documented with free-formed text.\n>\n> The issue has been fixed in Doxygen commit 309b397be106 (\"issue #8281:\n> Out-of-line documentation of scoped enums in the same namespace\"). We\n> can now fix the documentation.\n>\n> Signed-off-by: Laurent Pinchart \n\nReviewed-by: David Plowman \n\n> ---\n> src/libcamera/transform.cpp | 38 ++++++++++++++++++-------------------\n> 1 file changed, 19 insertions(+), 19 deletions(-)\n>\n> diff --git a/src/libcamera/transform.cpp b/src/libcamera/transform.cpp\n> index f3e37f313041..99a043ba14d3 100644\n> --- a/src/libcamera/transform.cpp\n> +++ b/src/libcamera/transform.cpp\n> @@ -43,7 +43,15 @@ namespace libcamera {\n> * couple of them have additional synonyms for convenience). We illustrate each\n> * with its nominal effect on a rectangle with vertices labelled A, B, C and D.\n> *\n> - * **Identity**\n> + * \\sa https://en.wikipedia.org/wiki/Examples_of_groups#dihedral_group_of_order_8\n> + *\n> + * The set of 2D plane transforms is also known as the symmetry group of a\n> + * square, described in the link. Note that the group can be generated by\n> + * only 2 elements (the horizontal flip and a 90 degree rotation, for\n> + * example), however, the encoding used here makes the presence of the vertical\n> + * flip explicit.\n> + *\n> + * \\var Transform::Identity\n> *\n> * Identity transform.\n> ~~~\n> @@ -53,11 +61,11 @@ Input image | | goes to output image | |\n> ~~~\n> * Numeric value: 0 (no bits set).\n> *\n> - * **Rot0**\n> + * \\var Transform::Rot0\n> *\n> - * Synonym for `Identity` (zero degree rotation).\n> + * Synonym for Transform::Identity (zero degree rotation).\n> *\n> - * **HFlip**\n> + * \\var Transform::HFlip\n> *\n> * Horizontal flip.\n> ~~~\n> @@ -67,7 +75,7 @@ Input image | | goes to output image | |\n> ~~~\n> * Numeric value: 1 (horizontal flip bit set only).\n> *\n> - * **VFlip**\n> + * \\var Transform::VFlip\n> *\n> * Vertical flip.\n> ~~~\n> @@ -77,7 +85,7 @@ Input image | | goes to output image | |\n> ~~~\n> * Numeric value: 2 (vertical flip bit set only).\n> *\n> - * **HVFlip**\n> + * \\var Transform::HVFlip\n> *\n> * Horizontal and vertical flip (identical to a 180 degree rotation).\n> ~~~\n> @@ -87,11 +95,11 @@ Input image | | goes to output image | |\n> ~~~\n> * Numeric value: 3 (horizontal and vertical flip bits set).\n> *\n> - * **Rot180**\n> + * \\var Transform::Rot180\n> *\n> * Synonym for `HVFlip` (180 degree rotation).\n> *\n> - * **Transpose**\n> + * \\var Transform::Transpose\n> *\n> * Transpose (about the main diagonal).\n> ~~~\n> @@ -101,7 +109,7 @@ Input image | | goes to output image | |\n> ~~~\n> * Numeric value: 4 (transpose bit set only).\n> *\n> - * **Rot270**\n> + * \\var Transform::Rot270\n> *\n> * Rotation by 270 degrees clockwise (90 degrees anticlockwise).\n> ~~~\n> @@ -111,7 +119,7 @@ Input image | | goes to output image | |\n> ~~~\n> * Numeric value: 5 (transpose and horizontal flip bits set).\n> *\n> - * **Rot90**\n> + * \\var Transform::Rot90\n> *\n> * Rotation by 90 degrees clockwise (270 degrees anticlockwise).\n> ~~~\n> @@ -121,7 +129,7 @@ Input image | | goes to output image | |\n> ~~~\n> * Numeric value: 6 (transpose and vertical flip bits set).\n> *\n> - * **Rot180Transpose**\n> + * \\var Transform::Rot180Transpose\n> *\n> * Rotation by 180 degrees followed by transpose (alternatively, transposition\n> * about the \"opposite diagonal\").\n> @@ -131,14 +139,6 @@ Input image | | goes to output image | |\n> C-D C-A\n> ~~~\n> * Numeric value: 7 (all bits set).\n> - *\n> - * \\sa https://en.wikipedia.org/wiki/Examples_of_groups#dihedral_group_of_order_8\n> - *\n> - * The set of 2D plane transforms is also known as the symmetry group of a\n> - * square, described in the link. Note that the group can be generated by\n> - * only 2 elements (the horizontal flip and a 90 degree rotation, for\n> - * example), however, the encoding used here makes the presence of the vertical\n> - * flip explicit.\n> */\n>\n> /**\n> --\n> Regards,\n>\n> Laurent Pinchart\n>","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3FF9AC0100\n\tfor ;\n\tMon, 5 Jul 2021 11:22:16 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 8D2AF684F9;\n\tMon, 5 Jul 2021 13:22:15 +0200 (CEST)","from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com\n\t[IPv6:2a00:1450:4864:20::42e])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id DB7CE6050A\n\tfor ;\n\tMon, 5 Jul 2021 13:22:12 +0200 (CEST)","by mail-wr1-x42e.google.com with SMTP id p8so21679336wrr.1\n\tfor ;\n\tMon, 05 Jul 2021 04:22:12 -0700 (PDT)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (2048-bit key;\n\tunprotected) header.d=raspberrypi.com header.i=@raspberrypi.com\n\theader.b=\"PV+Ttu3K\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=raspberrypi.com; s=google;\n\th=mime-version:references:in-reply-to:from:date:message-id:subject:to\n\t:cc; bh=FTuYdqdJTB97xfLu/WqDGmdW5VrRrWf+9gbl4vHpa/8=;\n\tb=PV+Ttu3KNXnqFmguO2/1TRqro9ZVzsIvLpU4CEZhcttjvCjBjNP8o7Kg1euPLrwXkZ\n\tNlDFOySP8qHiIrO75PXLPavh8LDsDACnUbM34+HJN8B+FHH6n9o+fSmJxu+95x5F/ETF\n\tFKEliG27hFzsD4OEqih7Qm4488xApnKpx9GRZrxpHmf/YNoSdOv4x950CTF029nQwgpj\n\tWvUfAf51NIPtOLMfeAgMoXGA/oWpje8jRbWQBAOeClmWBEtCcaSkZwJJLmJr1MrmANcL\n\t8rBQQxkyNdm7UcJtz7m7cRZEHck1N076WJ7eoTx3tklasmn+9M0adH6Tf42Z1AhsNnHi\n\t6pZw==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:mime-version:references:in-reply-to:from:date\n\t:message-id:subject:to:cc;\n\tbh=FTuYdqdJTB97xfLu/WqDGmdW5VrRrWf+9gbl4vHpa/8=;\n\tb=WjyQXcolEHf/7Q3qdAFkaQs/JkCrHODJWHyXUGxHHLz3GlZJNXG0iN9H2KKNpSinK9\n\tyH6KyD/PvGZ0Gz9PySLJjPsrms4wP3VK/ISBAUo4Pl9UaxUFleBrm1t7bywLfBNv8hxn\n\toUBb2SY4OADGtZ3+zHbzyhTA7yOs6sUeTioQaat8yp5mqWI0r0MRhrKyRY0ielhG0wHO\n\tqOipQbd8l/Nu2kP+7amIdLO96P1T31IdNmtQhh4D+RAtqz4u2U4ZbTYqhQ4nL7bB0BzP\n\tsMdzvJp+M2X23dY1v+a/WUoML89OI7bfURdYDErJCPRAumLBc/yIVz3oEqVxqVnGieWv\n\trkrQ==","X-Gm-Message-State":"AOAM5312I5/6X3+uEdXeu5il2Gy7cC7KOGtr7CtjPcetrk+BFoFq4YXs\n\tN4gEK5g9Og8MqdtywpAwYJoZVaKgAUedXfEWAe3ZjQ==","X-Google-Smtp-Source":"ABdhPJxUA9gGzlK87nidWrcEf5S63NzxbHvw/yAJTDSPERmhW3bDGvckNX3YELwV/4XcfGLemuQJSADIzgDMdnLBloQ=","X-Received":"by 2002:a5d:6484:: with SMTP id o4mr3997409wri.89.1625484132527; \n\tMon, 05 Jul 2021 04:22:12 -0700 (PDT)","MIME-Version":"1.0","References":"<20210704130546.21396-1-laurent.pinchart@ideasonboard.com>","In-Reply-To":"<20210704130546.21396-1-laurent.pinchart@ideasonboard.com>","From":"David Plowman ","Date":"Mon, 5 Jul 2021 12:22:00 +0100","Message-ID":"","To":"Laurent Pinchart ","Content-Type":"text/plain; charset=\"UTF-8\"","Subject":"Re: [libcamera-devel] [PATCH] libcamera: transform: Document\n\tTransform enumerators as such","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"libcamera devel ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]