{"id":12800,"url":"https://patchwork.libcamera.org/api/1.1/patches/12800/?format=json","web_url":"https://patchwork.libcamera.org/patch/12800/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20210704130546.21396-1-laurent.pinchart@ideasonboard.com>","date":"2021-07-04T13:05:46","name":"[libcamera-devel] libcamera: transform: Document Transform enumerators as such","commit_ref":"fb970d9cde339b89971465b854945798c27db7bf","pull_url":null,"state":"accepted","archived":false,"hash":"420b5f3318755257490474f0f49dcd88381be94c","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":{"id":14,"url":"https://patchwork.libcamera.org/api/1.1/users/14/?format=json","username":"pinchartl","first_name":"Laurent","last_name":"Pinchart","email":"laurent.pinchart@ideasonboard.com"},"mbox":"https://patchwork.libcamera.org/patch/12800/mbox/","series":[{"id":2204,"url":"https://patchwork.libcamera.org/api/1.1/series/2204/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2204","date":"2021-07-04T13:05:46","name":"[libcamera-devel] libcamera: transform: Document Transform enumerators as such","version":1,"mbox":"https://patchwork.libcamera.org/series/2204/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/12800/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/12800/checks/","tags":{},"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 0F2CDC0100\n\tfor ;\n\tSun, 4 Jul 2021 13:06:46 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 51CC768501;\n\tSun, 4 Jul 2021 15:06:45 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 5C4E3684E4\n\tfor ;\n\tSun, 4 Jul 2021 15:06:34 +0200 (CEST)","from pendragon.lan (62-78-145-57.bb.dnainternet.fi [62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id BA6B1E7;\n\tSun, 4 Jul 2021 15:06:33 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"ukhdmoq/\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1625403993;\n\tbh=qF+jQ/+4aty7vKBmagB5iW7okG7YZJgVbIWRDHBQmVs=;\n\th=From:To:Cc:Subject:Date:From;\n\tb=ukhdmoq/ZMHKE1uhj7wufmnpr0FHtZaLgbl5nTomZZpc24DgDjK6hRYqUGfUMKJ8q\n\tm0v8BzHuzHurdQLIlMX72ynHNrq52DeFdan+cuHRvLgWA+gg6saI9rh83xJ+xRygqo\n\tYElsbbC9VKGt5SyqFkI3B5mL9g53dAZgjB+nCXng=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Date":"Sun, 4 Jul 2021 16:05:46 +0300","Message-Id":"<20210704130546.21396-1-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.31.1","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH] libcamera: transform: Document Transform\n\tenumerators 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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Due to a bug in Doxygen that didn't properly handle enum class\nenumerators when defined in a namespace, the Transform enumerators were\ndocumented with free-formed text.\n\nThe issue has been fixed in Doxygen commit 309b397be106 (\"issue #8281:\nOut-of-line documentation of scoped enums in the same namespace\"). We\ncan now fix the documentation.\n\nSigned-off-by: Laurent Pinchart \n---\n src/libcamera/transform.cpp | 38 ++++++++++++++++++-------------------\n 1 file changed, 19 insertions(+), 19 deletions(-)","diff":"diff --git a/src/libcamera/transform.cpp b/src/libcamera/transform.cpp\nindex 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","prefixes":["libcamera-devel"]}