[{"id":3901,"web_url":"https://patchwork.libcamera.org/comment/3901/","msgid":"<7548e2b2-657f-ca29-f34a-8823e8acd102@ideasonboard.com>","date":"2020-03-02T22:25:20","subject":"Re: [libcamera-devel] [PATCH 03/31] libcamera: gen-controls: Fix\n\tdocumentation issue with <<","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent, Jacopo,\n\nOn 29/02/2020 16:42, Laurent Pinchart wrote:\n> From: Jacopo Mondi \n> \n> Doxygen fails to parse entries with multiple << signs as, in example,\n> \\var extern const Control>\n> \n\nIs this a bug in Doxygen? Has it been reported?\n\n> Remove the type from the control documentation as unique control and\n> properties name should not need any additional information specified for\n> Doxygen to correctly identify them.\n> \n> Not sure this patch is the right way to fix this, but it's mostly here\n> to highlight an issue.\n\nIf the unique control/property name is enough to satisfy doxygen, then\nI'd remove this last sentence and call this a suitable workaround...\n\n\nIn fact I'd say more than a workaround, this should be fine. We don't\nnormally have to specify the full type declaration for variables?\n\n> \n> Signed-off-by: Jacopo Mondi \n\nReviewed-by: Kieran Bingham \n\n> ---\n> src/libcamera/gen-controls.py | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n> \n> diff --git a/src/libcamera/gen-controls.py b/src/libcamera/gen-controls.py\n> index 773e9b5d170c..6f020a327827 100755\n> --- a/src/libcamera/gen-controls.py\n> +++ b/src/libcamera/gen-controls.py\n> @@ -29,7 +29,7 @@ def generate_cpp(controls):\n> enum_doc_value_template = string.Template(''' * \\\\var ${name}Values::${value}\n> ${description}''')\n> doc_template = string.Template('''/**\n> - * \\\\var extern const Control<${type}> ${name}\n> + * \\\\var ${name}\n> ${description}\n> */''')\n> def_template = string.Template('extern const Control<${type}> ${name}(${id_name}, \"${name}\");')\n>","headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 3209A627B6\n\tfor ;\n\tMon, 2 Mar 2020 23:25:27 +0100 (CET)","from [192.168.0.20]\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 82CF254A;\n\tMon, 2 Mar 2020 23:25:26 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1583187926;\n\tbh=JQ2Z3HqIFm1FbcIPYo45wftM2rxowTQFlVPOCNXaS9s=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=auaYLBdQzD5GZFrd3+Wosm4flnAQrTvRbdDsr4LXXIwlqZWJx3pWVfPoRwIP9+mYU\n\tM+Sj/IxWpdraUySYXj85rGW9TACOBjOS0JkkNF3DBx35be59d11tl+j+7pPilYfKkw\n\tQnhW6UDACy9n5wu32MpZYWtuwMW7Rpr49ouWe+rA=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20200229164254.23604-1-laurent.pinchart@ideasonboard.com>\n\t<20200229164254.23604-4-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham ","Openpgp":"preference=signencrypt","Autocrypt":"addr=kieran.bingham@ideasonboard.com; keydata=\n\tmQINBFYE/WYBEACs1PwjMD9rgCu1hlIiUA1AXR4rv2v+BCLUq//vrX5S5bjzxKAryRf0uHat\n\tV/zwz6hiDrZuHUACDB7X8OaQcwhLaVlq6byfoBr25+hbZG7G3+5EUl9cQ7dQEdvNj6V6y/SC\n\trRanWfelwQThCHckbobWiQJfK9n7rYNcPMq9B8e9F020LFH7Kj6YmO95ewJGgLm+idg1Kb3C\n\tpotzWkXc1xmPzcQ1fvQMOfMwdS+4SNw4rY9f07Xb2K99rjMwZVDgESKIzhsDB5GY465sCsiQ\n\tcSAZRxqE49RTBq2+EQsbrQpIc8XiffAB8qexh5/QPzCmR4kJgCGeHIXBtgRj+nIkCJPZvZtf\n\tKr2EAbc6tgg6DkAEHJb+1okosV09+0+TXywYvtEop/WUOWQ+zo+Y/OBd+8Ptgt1pDRyOBzL8\n\tRXa8ZqRf0Mwg75D+dKntZeJHzPRJyrlfQokngAAs4PaFt6UfS+ypMAF37T6CeDArQC41V3ko\n\tlPn1yMsVD0p+6i3DPvA/GPIksDC4owjnzVX9kM8Zc5Cx+XoAN0w5Eqo4t6qEVbuettxx55gq\n\t8K8FieAjgjMSxngo/HST8TpFeqI5nVeq0/lqtBRQKumuIqDg+Bkr4L1V/PSB6XgQcOdhtd36\n\tOe9X9dXB8YSNt7VjOcO7BTmFn/Z8r92mSAfHXpb07YJWJosQOQARAQABtDBLaWVyYW4gQmlu\n\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAlcEEwEKAEECGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEWIQSQLdeYP70o/eNy1HqhHkZyEKRh/QUCXWTtygUJ\n\tCyJXZAAKCRChHkZyEKRh/f8dEACTDsbLN2nioNZMwyLuQRUAFcXNolDX48xcUXsWS2QjxaPm\n\tVsJx8Uy8aYkS85mdPBh0C83OovQR/OVbr8AxhGvYqBs3nQvbWuTl/+4od7DfK2VZOoKBAu5S\n\tQK2FYuUcikDqYcFWJ8DQnubxfE8dvzojHEkXw0sA4igINHDDFX3HJGZtLio+WpEFQtCbfTAG\n\tYZslasz1YZRbwEdSsmO3/kqy5eMnczlm8a21A3fKUo3g8oAZEFM+f4DUNzqIltg31OAB/kZS\n\tenKZQ/SWC8PmLg/ZXBrReYakxXtkP6w3FwMlzOlhGxqhIRNiAJfXJBaRhuUWzPOpEDE9q5YJ\n\tBmqQL2WJm1VSNNVxbXJHpaWMH1sA2R00vmvRrPXGwyIO0IPYeUYQa3gsy6k+En/aMQJd27dp\n\taScf9am9PFICPY5T4ppneeJLif2lyLojo0mcHOV+uyrds9XkLpp14GfTkeKPdPMrLLTsHRfH\n\tfA4I4OBpRrEPiGIZB/0im98MkGY/Mu6qxeZmYLCcgD6qz4idOvfgVOrNh+aA8HzIVR+RMW8H\n\tQGBN9f0E3kfwxuhl3omo6V7lDw8XOdmuWZNC9zPq1UfryVHANYbLGz9KJ4Aw6M+OgBC2JpkD\n\thXMdHUkC+d20dwXrwHTlrJi1YNp6rBc+xald3wsUPOZ5z8moTHUX/uPA/qhGsbkCDQRWBP1m\n\tARAAzijkb+Sau4hAncr1JjOY+KyFEdUNxRy+hqTJdJfaYihxyaj0Ee0P0zEi35CbE6lgU0Uz\n\ttih9fiUbSV3wfsWqg1Ut3/5rTKu7kLFp15kF7eqvV4uezXRD3Qu4yjv/rMmEJbbD4cTvGCYI\n\td6MDC417f7vK3hCbCVIZSp3GXxyC1LU+UQr3fFcOyCwmP9vDUR9JV0BSqHHxRDdpUXE26Dk6\n\tmhf0V1YkspE5St814ETXpEus2urZE5yJIUROlWPIL+hm3NEWfAP06vsQUyLvr/GtbOT79vXl\n\tEn1aulcYyu20dRRxhkQ6iILaURcxIAVJJKPi8dsoMnS8pB0QW12AHWuirPF0g6DiuUfPmrA5\n\tPKe56IGlpkjc8cO51lIxHkWTpCMWigRdPDexKX+Sb+W9QWK/0JjIc4t3KBaiG8O4yRX8ml2R\n\t+rxfAVKM6V769P/hWoRGdgUMgYHFpHGSgEt80OKK5HeUPy2cngDUXzwrqiM5Sz6Od0qw5pCk\n\tNlXqI0W/who0iSVM+8+RmyY0OEkxEcci7rRLsGnM15B5PjLJjh1f2ULYkv8s4SnDwMZ/kE04\n\t/UqCMK/KnX8pwXEMCjz0h6qWNpGwJ0/tYIgQJZh6bqkvBrDogAvuhf60Sogw+mH8b+PBlx1L\n\toeTK396wc+4c3BfiC6pNtUS5GpsPMMjYMk7kVvEAEQEAAYkCPAQYAQoAJgIbDBYhBJAt15g/\n\tvSj943LUeqEeRnIQpGH9BQJdizzIBQkLSKZiAAoJEKEeRnIQpGH9eYgQAJpjaWNgqNOnMTmD\n\tMJggbwjIotypzIXfhHNCeTkG7+qCDlSaBPclcPGYrTwCt0YWPU2TgGgJrVhYT20ierN8LUvj\n\t6qOPTd+Uk7NFzL65qkh80ZKNBFddx1AabQpSVQKbdcLb8OFs85kuSvFdgqZwgxA1vl4TFhNz\n\tPZ79NAmXLackAx3sOVFhk4WQaKRshCB7cSl+RIng5S/ThOBlwNlcKG7j7W2MC06BlTbdEkUp\n\tECzuuRBv8wX4OQl+hbWbB/VKIx5HKlLu1eypen/5lNVzSqMMIYkkZcjV2SWQyUGxSwq0O/sx\n\tS0A8/atCHUXOboUsn54qdxrVDaK+6jIAuo8JiRWctP16KjzUM7MO0/+4zllM8EY57rXrj48j\n\tsbEYX0YQnzaj+jO6kJtoZsIaYR7rMMq9aUAjyiaEZpmP1qF/2sYenDx0Fg2BSlLvLvXM0vU8\n\tpQk3kgDu7kb/7PRYrZvBsr21EIQoIjXbZxDz/o7z95frkP71EaICttZ6k9q5oxxA5WC6sTXc\n\tMW8zs8avFNuA9VpXt0YupJd2ijtZy2mpZNG02fFVXhIn4G807G7+9mhuC4XG5rKlBBUXTvPU\n\tAfYnB4JBDLmLzBFavQfvonSfbitgXwCG3vS+9HEwAjU30Bar1PEOmIbiAoMzuKeRm2LVpmq4\n\tWZw01QYHU/GUV/zHJSFk","Organization":"Ideas on Board","Message-ID":"<7548e2b2-657f-ca29-f34a-8823e8acd102@ideasonboard.com>","Date":"Mon, 2 Mar 2020 22:25:20 +0000","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.9.1","MIME-Version":"1.0","In-Reply-To":"<20200229164254.23604-4-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH 03/31] libcamera: gen-controls: Fix\n\tdocumentation issue with <<","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","X-List-Received-Date":"Mon, 02 Mar 2020 22:25:27 -0000"}},{"id":3922,"web_url":"https://patchwork.libcamera.org/comment/3922/","msgid":"<20200303171612.GB11333@pendragon.ideasonboard.com>","date":"2020-03-03T17:16:12","subject":"Re: [libcamera-devel] [PATCH 03/31] libcamera: gen-controls: Fix\n\tdocumentation issue with <<","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nOn Mon, Mar 02, 2020 at 10:25:20PM +0000, Kieran Bingham wrote:\n> On 29/02/2020 16:42, Laurent Pinchart wrote:\n> > From: Jacopo Mondi \n> > \n> > Doxygen fails to parse entries with multiple << signs as, in example,\n> > \\var extern const Control>\n> \n> Is this a bug in Doxygen? Has it been reported?\n\nI believe it is. https://github.com/doxygen/doxygen/issues/7625\n\n> > Remove the type from the control documentation as unique control and\n> > properties name should not need any additional information specified for\n> > Doxygen to correctly identify them.\n> > \n> > Not sure this patch is the right way to fix this, but it's mostly here\n> > to highlight an issue.\n> \n> If the unique control/property name is enough to satisfy doxygen, then\n> I'd remove this last sentence and call this a suitable workaround...\n> \n> In fact I'd say more than a workaround, this should be fine. We don't\n> normally have to specify the full type declaration for variables?\n\nYes, I think that's fine. I'll remove the last sentence.\n\n> > Signed-off-by: Jacopo Mondi \n> \n> Reviewed-by: Kieran Bingham \n> \n> > ---\n> > src/libcamera/gen-controls.py | 2 +-\n> > 1 file changed, 1 insertion(+), 1 deletion(-)\n> > \n> > diff --git a/src/libcamera/gen-controls.py b/src/libcamera/gen-controls.py\n> > index 773e9b5d170c..6f020a327827 100755\n> > --- a/src/libcamera/gen-controls.py\n> > +++ b/src/libcamera/gen-controls.py\n> > @@ -29,7 +29,7 @@ def generate_cpp(controls):\n> > enum_doc_value_template = string.Template(''' * \\\\var ${name}Values::${value}\n> > ${description}''')\n> > doc_template = string.Template('''/**\n> > - * \\\\var extern const Control<${type}> ${name}\n> > + * \\\\var ${name}\n> > ${description}\n> > */''')\n> > def_template = string.Template('extern const Control<${type}> ${name}(${id_name}, \"${name}\");')\n> >","headers":{"Return-Path":"","Received":["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 ACC6A60427\n\tfor ;\n\tTue, 3 Mar 2020 18:16:33 +0100 (CET)","from pendragon.ideasonboard.com (81-175-216-236.bb.dnainternet.fi\n\t[81.175.216.236])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 1C44F2AF;\n\tTue, 3 Mar 2020 18:16:33 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1583255793;\n\tbh=XpCZHzfFaJo7K5V8KQST4iWlpl216w+LCAb0kGoG56A=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=lDt8WV+RsQai1NXVAD46VG3X3EXbmAXHugY8caSsjnbyi6HLzObE+XMIFmgqIHvZ/\n\tbKVV2JcA9qQU8ND8yJvMzFDkO25rSkvcAAJDJ0dGYfZLzVdkTuyKNMNTnVFzXMXTez\n\tbPaAnNVZif92R8MUBJhf04SV4hykXUlL1oYcIJ+w=","Date":"Tue, 3 Mar 2020 19:16:12 +0200","From":"Laurent Pinchart ","To":"Kieran Bingham ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20200303171612.GB11333@pendragon.ideasonboard.com>","References":"<20200229164254.23604-1-laurent.pinchart@ideasonboard.com>\n\t<20200229164254.23604-4-laurent.pinchart@ideasonboard.com>\n\t<7548e2b2-657f-ca29-f34a-8823e8acd102@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<7548e2b2-657f-ca29-f34a-8823e8acd102@ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 03/31] libcamera: gen-controls: Fix\n\tdocumentation issue with <<","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","X-List-Received-Date":"Tue, 03 Mar 2020 17:16:33 -0000"}}]