[{"id":13262,"web_url":"https://patchwork.libcamera.org/comment/13262/","msgid":"<20201020031812.GE2041@pyrite.rasen.tech>","date":"2020-10-20T03:18:12","subject":"Re: [libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for\n\tpipeline-specific IPA headers","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/people/17/","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"content":"Hi Laurent,\n\nOn Tue, Oct 20, 2020 at 03:03:07AM +0300, Laurent Pinchart wrote:\n> The pipeline-specific IPA headers are not part of the libcamera API,\n> they should thus be skipped when generating documentation. doxygen\n> doesn't complain currently due to the fact that types defined in those\n> headers are part of undocumented namespaces. In preparation for\n> documenting the libcamera namespace, make sure the headers don't get\n> parsed by doxygen.\n> \n> Only vimc.h needs a header guard, as rkisp1.h uses the global namespace\n> and raspberrypi.h uses the undocumented libcamera::RPi namespace,\n> neither of which cause issues. Still, for consistency, add header guards\n> to all headers.\n\nI'm not sure how I feel about putting the header files in a different\ndirectory... pipeline doesn't feel like the right subdirectory name, and\nif we use ipa instead it'll become a really nice\n :)\n\nI think the #ifndef is fine. It's like an extension of the include\nguard.\n\n> Signed-off-by: Laurent Pinchart \n\nReviewed-by: Paul Elder \n\n> ---\n> include/libcamera/ipa/raspberrypi.h | 4 ++++\n> include/libcamera/ipa/rkisp1.h | 4 ++++\n> include/libcamera/ipa/vimc.h | 4 ++++\n> 3 files changed, 12 insertions(+)\n> \n> diff --git a/include/libcamera/ipa/raspberrypi.h b/include/libcamera/ipa/raspberrypi.h\n> index b3041591ff7c..b23baf2f1330 100644\n> --- a/include/libcamera/ipa/raspberrypi.h\n> +++ b/include/libcamera/ipa/raspberrypi.h\n> @@ -10,6 +10,8 @@\n> #include \n> #include \n> \n> +#ifndef __DOXYGEN__\n> +\n> namespace libcamera {\n> \n> namespace RPi {\n> @@ -66,4 +68,6 @@ static const ControlInfoMap Controls = {\n> \n> } /* namespace libcamera */\n> \n> +#endif /* __DOXYGEN__ */\n> +\n> #endif /* __LIBCAMERA_IPA_INTERFACE_RASPBERRYPI_H__ */\n> diff --git a/include/libcamera/ipa/rkisp1.h b/include/libcamera/ipa/rkisp1.h\n> index 4fe0482b8de5..bb824f292032 100644\n> --- a/include/libcamera/ipa/rkisp1.h\n> +++ b/include/libcamera/ipa/rkisp1.h\n> @@ -7,6 +7,8 @@\n> #ifndef __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n> #define __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n> \n> +#ifndef __DOXYGEN__\n> +\n> enum RkISP1Operations {\n> \tRKISP1_IPA_ACTION_V4L2_SET = 1,\n> \tRKISP1_IPA_ACTION_PARAM_FILLED = 2,\n> @@ -15,4 +17,6 @@ enum RkISP1Operations {\n> \tRKISP1_IPA_EVENT_QUEUE_REQUEST = 5,\n> };\n> \n> +#endif /* __DOXYGEN__ */\n> +\n> #endif /* __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ */\n> diff --git a/include/libcamera/ipa/vimc.h b/include/libcamera/ipa/vimc.h\n> index 22d97992f80f..27a4a61df889 100644\n> --- a/include/libcamera/ipa/vimc.h\n> +++ b/include/libcamera/ipa/vimc.h\n> @@ -8,6 +8,8 @@\n> #ifndef __LIBCAMERA_IPA_VIMC_H__\n> #define __LIBCAMERA_IPA_VIMC_H__\n> \n> +#ifndef __DOXYGEN__\n> +\n> namespace libcamera {\n> \n> #define VIMC_IPA_FIFO_PATH \"/tmp/libcamera_ipa_vimc_fifo\"\n> @@ -21,4 +23,6 @@ enum IPAOperationCode {\n> \n> } /* namespace libcamera */\n> \n> +#endif /* __DOXYGEN__ */\n> +\n> #endif /* __LIBCAMERA_IPA_VIMC_H__ */\n> -- \n> Regards,\n> \n> Laurent Pinchart\n> \n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","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 081A0BDB1F\n\tfor ;\n\tTue, 20 Oct 2020 03:18:21 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 82CBF613AD;\n\tTue, 20 Oct 2020 05:18:20 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 29BD26052F\n\tfor ;\n\tTue, 20 Oct 2020 05:18:19 +0200 (CEST)","from pyrite.rasen.tech (unknown\n\t[IPv6:2400:4051:61:600:2c71:1b79:d06d:5032])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D097852;\n\tTue, 20 Oct 2020 05:18:17 +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=\"i3VNfQgh\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1603163898;\n\tbh=xxsTQzso4z+Tmj0GCMAE0zTxWeWZ8hL/Wvj8w8G8qds=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=i3VNfQghvWYVcR0AE172NfBfwNdxdCiLCIQM49TjmZ7sGKDZ4J2fH32ILWCFx0Iqs\n\txHcg4sSwH0+DoRKfhyO9Bw0Td8LbI5KKeXqo6bXqcxoKgMh5+FWkqbExetP3BK4iZO\n\tHUeafD01ltvVhm6QVgtRvLUY9IKXSf5YkLBJ6bNc=","Date":"Tue, 20 Oct 2020 12:18:12 +0900","From":"paul.elder@ideasonboard.com","To":"Laurent Pinchart ","Message-ID":"<20201020031812.GE2041@pyrite.rasen.tech>","References":"<20201020000310.3008-1-laurent.pinchart@ideasonboard.com>\n\t<20201020000310.3008-3-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20201020000310.3008-3-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for\n\tpipeline-specific IPA headers","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@lists.libcamera.org","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":13290,"web_url":"https://patchwork.libcamera.org/comment/13290/","msgid":"<7cbd482a-a2f4-ece8-16d5-028b0632b306@ideasonboard.com>","date":"2020-10-20T10:15:07","subject":"Re: [libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for\n\tpipeline-specific IPA headers","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 20/10/2020 01:03, Laurent Pinchart wrote:\n> The pipeline-specific IPA headers are not part of the libcamera API,\n> they should thus be skipped when generating documentation. doxygen\n> doesn't complain currently due to the fact that types defined in those\n> headers are part of undocumented namespaces. In preparation for\n> documenting the libcamera namespace, make sure the headers don't get\n> parsed by doxygen.\n> \n> Only vimc.h needs a header guard, as rkisp1.h uses the global namespace\n> and raspberrypi.h uses the undocumented libcamera::RPi namespace,\n> neither of which cause issues. Still, for consistency, add header guards\n> to all headers.\n\nI sort of like the RPI implementation here.\n\nGiving each IPA it's own namespace ... ?\n\nBut I won't object to this if you prefer it.\n\nI don't think the extra subdir in include/libcamera/ipa/\nmakes sense at the moment.\n\nAcked-by: Kieran Bingham \n\n> Signed-off-by: Laurent Pinchart \n> ---\n> include/libcamera/ipa/raspberrypi.h | 4 ++++\n> include/libcamera/ipa/rkisp1.h | 4 ++++\n> include/libcamera/ipa/vimc.h | 4 ++++\n> 3 files changed, 12 insertions(+)\n> \n> diff --git a/include/libcamera/ipa/raspberrypi.h b/include/libcamera/ipa/raspberrypi.h\n> index b3041591ff7c..b23baf2f1330 100644\n> --- a/include/libcamera/ipa/raspberrypi.h\n> +++ b/include/libcamera/ipa/raspberrypi.h\n> @@ -10,6 +10,8 @@\n> #include \n> #include \n> \n> +#ifndef __DOXYGEN__\n> +\n> namespace libcamera {\n> \n> namespace RPi {\n> @@ -66,4 +68,6 @@ static const ControlInfoMap Controls = {\n> \n> } /* namespace libcamera */\n> \n> +#endif /* __DOXYGEN__ */\n> +\n> #endif /* __LIBCAMERA_IPA_INTERFACE_RASPBERRYPI_H__ */\n> diff --git a/include/libcamera/ipa/rkisp1.h b/include/libcamera/ipa/rkisp1.h\n> index 4fe0482b8de5..bb824f292032 100644\n> --- a/include/libcamera/ipa/rkisp1.h\n> +++ b/include/libcamera/ipa/rkisp1.h\n> @@ -7,6 +7,8 @@\n> #ifndef __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n> #define __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n> \n> +#ifndef __DOXYGEN__\n> +\n> enum RkISP1Operations {\n> \tRKISP1_IPA_ACTION_V4L2_SET = 1,\n> \tRKISP1_IPA_ACTION_PARAM_FILLED = 2,\n> @@ -15,4 +17,6 @@ enum RkISP1Operations {\n> \tRKISP1_IPA_EVENT_QUEUE_REQUEST = 5,\n> };\n> \n> +#endif /* __DOXYGEN__ */\n> +\n> #endif /* __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ */\n> diff --git a/include/libcamera/ipa/vimc.h b/include/libcamera/ipa/vimc.h\n> index 22d97992f80f..27a4a61df889 100644\n> --- a/include/libcamera/ipa/vimc.h\n> +++ b/include/libcamera/ipa/vimc.h\n> @@ -8,6 +8,8 @@\n> #ifndef __LIBCAMERA_IPA_VIMC_H__\n> #define __LIBCAMERA_IPA_VIMC_H__\n> \n> +#ifndef __DOXYGEN__\n> +\n> namespace libcamera {\n> \n> #define VIMC_IPA_FIFO_PATH \"/tmp/libcamera_ipa_vimc_fifo\"\n> @@ -21,4 +23,6 @@ enum IPAOperationCode {\n> \n> } /* namespace libcamera */\n> \n> +#endif /* __DOXYGEN__ */\n> +\n> #endif /* __LIBCAMERA_IPA_VIMC_H__ */\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 12BB7BDB1F\n\tfor ;\n\tTue, 20 Oct 2020 10:15:12 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A776F61394;\n\tTue, 20 Oct 2020 12:15:11 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 01EBD603AF\n\tfor ;\n\tTue, 20 Oct 2020 12:15:10 +0200 (CEST)","from [192.168.0.20]\n\t(cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 7E9F952;\n\tTue, 20 Oct 2020 12:15:09 +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=\"VZZ/tUZH\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1603188909;\n\tbh=Idq9lc5y9/RDf2GPGpx4XWFl2NoDY0ZbmGfz/3p45rc=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=VZZ/tUZH7McDUJ9NPme1ILXzzNRGfFnulY+ryeczQ8VbpHa0t4ITFMKDFalEphxQ0\n\trLFI2MLxLm+iCrphTycsr8/HlS8lZYBq4qfP7dmgd2beYNEH267kOUr9S16J+NrwCP\n\tb0z76+Z6kSHcVyiO3SufO7BZdfvjNEUBTEnA4+/I=","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20201020000310.3008-1-laurent.pinchart@ideasonboard.com>\n\t<20201020000310.3008-3-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham ","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":"<7cbd482a-a2f4-ece8-16d5-028b0632b306@ideasonboard.com>","Date":"Tue, 20 Oct 2020 11:15:07 +0100","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101\n\tThunderbird/68.10.0","MIME-Version":"1.0","In-Reply-To":"<20201020000310.3008-3-laurent.pinchart@ideasonboard.com>","Content-Language":"en-GB","Subject":"Re: [libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for\n\tpipeline-specific IPA headers","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","Reply-To":"kieran.bingham@ideasonboard.com","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":13292,"web_url":"https://patchwork.libcamera.org/comment/13292/","msgid":"<20201020101821.GO18688@pendragon.ideasonboard.com>","date":"2020-10-20T10:18:21","subject":"Re: [libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for\n\tpipeline-specific IPA headers","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nOn Tue, Oct 20, 2020 at 11:15:07AM +0100, Kieran Bingham wrote:\n> On 20/10/2020 01:03, Laurent Pinchart wrote:\n> > The pipeline-specific IPA headers are not part of the libcamera API,\n> > they should thus be skipped when generating documentation. doxygen\n> > doesn't complain currently due to the fact that types defined in those\n> > headers are part of undocumented namespaces. In preparation for\n> > documenting the libcamera namespace, make sure the headers don't get\n> > parsed by doxygen.\n> > \n> > Only vimc.h needs a header guard, as rkisp1.h uses the global namespace\n> > and raspberrypi.h uses the undocumented libcamera::RPi namespace,\n> > neither of which cause issues. Still, for consistency, add header guards\n> > to all headers.\n> \n> I sort of like the RPI implementation here.\n> \n> Giving each IPA it's own namespace ... ?\n\nI think that would make sense, but it's much more intrusive, so I'd like\nto keep it out of this series for now.\n\n> But I won't object to this if you prefer it.\n> \n> I don't think the extra subdir in include/libcamera/ipa/\n> makes sense at the moment.\n>\n> Acked-by: Kieran Bingham \n> \n> > Signed-off-by: Laurent Pinchart \n> > ---\n> > include/libcamera/ipa/raspberrypi.h | 4 ++++\n> > include/libcamera/ipa/rkisp1.h | 4 ++++\n> > include/libcamera/ipa/vimc.h | 4 ++++\n> > 3 files changed, 12 insertions(+)\n> > \n> > diff --git a/include/libcamera/ipa/raspberrypi.h b/include/libcamera/ipa/raspberrypi.h\n> > index b3041591ff7c..b23baf2f1330 100644\n> > --- a/include/libcamera/ipa/raspberrypi.h\n> > +++ b/include/libcamera/ipa/raspberrypi.h\n> > @@ -10,6 +10,8 @@\n> > #include \n> > #include \n> > \n> > +#ifndef __DOXYGEN__\n> > +\n> > namespace libcamera {\n> > \n> > namespace RPi {\n> > @@ -66,4 +68,6 @@ static const ControlInfoMap Controls = {\n> > \n> > } /* namespace libcamera */\n> > \n> > +#endif /* __DOXYGEN__ */\n> > +\n> > #endif /* __LIBCAMERA_IPA_INTERFACE_RASPBERRYPI_H__ */\n> > diff --git a/include/libcamera/ipa/rkisp1.h b/include/libcamera/ipa/rkisp1.h\n> > index 4fe0482b8de5..bb824f292032 100644\n> > --- a/include/libcamera/ipa/rkisp1.h\n> > +++ b/include/libcamera/ipa/rkisp1.h\n> > @@ -7,6 +7,8 @@\n> > #ifndef __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n> > #define __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n> > \n> > +#ifndef __DOXYGEN__\n> > +\n> > enum RkISP1Operations {\n> > \tRKISP1_IPA_ACTION_V4L2_SET = 1,\n> > \tRKISP1_IPA_ACTION_PARAM_FILLED = 2,\n> > @@ -15,4 +17,6 @@ enum RkISP1Operations {\n> > \tRKISP1_IPA_EVENT_QUEUE_REQUEST = 5,\n> > };\n> > \n> > +#endif /* __DOXYGEN__ */\n> > +\n> > #endif /* __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ */\n> > diff --git a/include/libcamera/ipa/vimc.h b/include/libcamera/ipa/vimc.h\n> > index 22d97992f80f..27a4a61df889 100644\n> > --- a/include/libcamera/ipa/vimc.h\n> > +++ b/include/libcamera/ipa/vimc.h\n> > @@ -8,6 +8,8 @@\n> > #ifndef __LIBCAMERA_IPA_VIMC_H__\n> > #define __LIBCAMERA_IPA_VIMC_H__\n> > \n> > +#ifndef __DOXYGEN__\n> > +\n> > namespace libcamera {\n> > \n> > #define VIMC_IPA_FIFO_PATH \"/tmp/libcamera_ipa_vimc_fifo\"\n> > @@ -21,4 +23,6 @@ enum IPAOperationCode {\n> > \n> > } /* namespace libcamera */\n> > \n> > +#endif /* __DOXYGEN__ */\n> > +\n> > #endif /* __LIBCAMERA_IPA_VIMC_H__ */\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 197C8BDB13\n\tfor ;\n\tTue, 20 Oct 2020 10:19:09 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A870E61394;\n\tTue, 20 Oct 2020 12:19:08 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 239B4603AF\n\tfor ;\n\tTue, 20 Oct 2020 12:19:08 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 8FF8252;\n\tTue, 20 Oct 2020 12:19:07 +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=\"LwHHx588\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1603189147;\n\tbh=VgQbl1KCkgJgmUzoiZoDCNaWadtHMPt1FGj2N112U7s=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=LwHHx5885oiDe4aWC+RvMrA46j6g5cVs9t0BjQ1tLl4dypybKaxSj/SIXjC0YCQYy\n\tMvkXhwr9EXYvjMc/BAbJIXSm0Gr7mV6cNA8amYId/xjsf4nWnHtu2DT8wBy0mZZnhF\n\tgPJvHxQXfwAVJZG9y5UUlhutFbcILYfRa1NvbQ0I=","Date":"Tue, 20 Oct 2020 13:18:21 +0300","From":"Laurent Pinchart ","To":"Kieran Bingham ","Message-ID":"<20201020101821.GO18688@pendragon.ideasonboard.com>","References":"<20201020000310.3008-1-laurent.pinchart@ideasonboard.com>\n\t<20201020000310.3008-3-laurent.pinchart@ideasonboard.com>\n\t<7cbd482a-a2f4-ece8-16d5-028b0632b306@ideasonboard.com>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<7cbd482a-a2f4-ece8-16d5-028b0632b306@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for\n\tpipeline-specific IPA headers","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@lists.libcamera.org","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]