[{"id":35794,"web_url":"https://patchwork.libcamera.org/comment/35794/","msgid":"","date":"2025-09-12T09:00:03","subject":"Re: [PATCH v2 09/10] Documentation: mainpage: Make it easier to\n\tdistinguish public and internal API","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/people/216/","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"content":"2025. 09. 12. 1:01 keltezéssel, Laurent Pinchart írta:\n> From: Stefan Klug \n> \n> It might be confusion to customers to see very similar looking doxygen\n ^\n confusing\n\n\n> documentation with different content. Improve that by clearly stating\n> 'public API' or 'internal API' on the main page.\n> \n> Signed-off-by: Stefan Klug \n> Reviewed-by: Laurent Pinchart \n> Signed-off-by: Laurent Pinchart \n> ---\n\nReviewed-by: Barnabás Pőcze \n\n\n> Changes since v1:\n> \n> - Rename \"libcamera Public-API reference\" to \"libcamera public API\n> reference\" (and same for the internal API)\n> ---\n> Documentation/mainpage.dox | 6 +++++-\n> 1 file changed, 5 insertions(+), 1 deletion(-)\n> \n> diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\n> index cbee9bab12ec..fae99f28f1af 100644\n> --- a/Documentation/mainpage.dox\n> +++ b/Documentation/mainpage.dox\n> @@ -1,5 +1,9 @@\n> /**\n> -\\mainpage libcamera API reference\n> +\\if internal\n> +\\mainpage libcamera internal API reference\n> +\\else\n> +\\mainpage libcamera public API reference\n> +\\endif\n> \n> Welcome to the API reference for libcamera,\n> a complex camera support library for Linux, Android and ChromeOS. These pages","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 81572BDB13\n\tfor ;\n\tFri, 12 Sep 2025 09:00:10 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 630AE6936E;\n\tFri, 12 Sep 2025 11:00:09 +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 CDDB8613A3\n\tfor ;\n\tFri, 12 Sep 2025 11:00:07 +0200 (CEST)","from [192.168.33.2] (185.221.142.115.nat.pool.zt.hu\n\t[185.221.142.115])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 70FBE6DF;\n\tFri, 12 Sep 2025 10:58:52 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"SX7sQ36f\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757667532;\n\tbh=bengFo1WtHnCQrtHwnrT/7kfS5wl3lH8rcSVHzowa4s=;\n\th=Date:Subject:To:Cc:References:From:In-Reply-To:From;\n\tb=SX7sQ36f+xF/Od+0fbJzVl17jJg5dYL6y6BMR1Fno3mogu3I3+rCw/w5/WVvf7iAy\n\t2K+9z7/MgQukGruZ6sctOaGDGzk5cdEDsfe58WrhLK1YPjPwppXC/7ZKqtUtDR6bK1\n\tBmrJHTMpVmzkdsdLnL7rwYIoUz1IGd2cSjal0+SA=","Message-ID":"","Date":"Fri, 12 Sep 2025 11:00:03 +0200","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH v2 09/10] Documentation: mainpage: Make it easier to\n\tdistinguish public and internal API","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","Cc":"Stefan Klug ","References":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>\n\t<20250911230115.25335-10-laurent.pinchart@ideasonboard.com>","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Content-Language":"en-US, hu-HU","In-Reply-To":"<20250911230115.25335-10-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"8bit","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\" "}},{"id":35813,"web_url":"https://patchwork.libcamera.org/comment/35813/","msgid":"<20250912172215.GC29172@pendragon.ideasonboard.com>","date":"2025-09-12T17:22:15","subject":"Re: [PATCH v2 09/10] Documentation: mainpage: Make it easier to\n\tdistinguish public and internal API","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Fri, Sep 12, 2025 at 11:00:03AM +0200, Barnabás Pőcze wrote:\n> 2025. 09. 12. 1:01 keltezéssel, Laurent Pinchart írta:\n> > From: Stefan Klug \n> > \n> > It might be confusion to customers to see very similar looking doxygen\n> ^\n> confusing\n\nI'll replace \"customers\" to \"consumers\" too.\n\n> > documentation with different content. Improve that by clearly stating\n> > 'public API' or 'internal API' on the main page.\n> > \n> > Signed-off-by: Stefan Klug \n> > Reviewed-by: Laurent Pinchart \n> > Signed-off-by: Laurent Pinchart \n> > ---\n> \n> Reviewed-by: Barnabás Pőcze \n> \n> > Changes since v1:\n> > \n> > - Rename \"libcamera Public-API reference\" to \"libcamera public API\n> > reference\" (and same for the internal API)\n> > ---\n> > Documentation/mainpage.dox | 6 +++++-\n> > 1 file changed, 5 insertions(+), 1 deletion(-)\n> > \n> > diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\n> > index cbee9bab12ec..fae99f28f1af 100644\n> > --- a/Documentation/mainpage.dox\n> > +++ b/Documentation/mainpage.dox\n> > @@ -1,5 +1,9 @@\n> > /**\n> > -\\mainpage libcamera API reference\n> > +\\if internal\n> > +\\mainpage libcamera internal API reference\n> > +\\else\n> > +\\mainpage libcamera public API reference\n> > +\\endif\n> > \n> > Welcome to the API reference for libcamera,\n> > a complex camera support library for Linux, Android and ChromeOS. These pages","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 EFB99C324E\n\tfor ;\n\tFri, 12 Sep 2025 17:22:44 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id F08156936F;\n\tFri, 12 Sep 2025 19:22:43 +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 5ED4969367\n\tfor ;\n\tFri, 12 Sep 2025 19:22:42 +0200 (CEST)","from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 64C5EC7A;\n\tFri, 12 Sep 2025 19:21:26 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"Kaa6qmWo\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757697686;\n\tbh=3RuIkE/ihBtQDgwc9P5MeCpVQDuVzooqwg74i2ml8qs=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=Kaa6qmWoeIm7+SDw2Cum8fSkOCnQ+3bqKfkncdhTOB3DSMkjVclCveeQz7DlRaEdU\n\t7u1L9C/huUYFoOLeYxKgdRGbL+jLRP5c9jO0Ypfox+OFkqa8/JdEeARwYuR9GzLxEB\n\t3GnRvX8iqgJBsVCQDqtBWN2UCcXAvykaV11+Pwb0=","Date":"Fri, 12 Sep 2025 20:22:15 +0300","From":"Laurent Pinchart ","To":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Cc":"libcamera-devel@lists.libcamera.org,\n\tStefan Klug ","Subject":"Re: [PATCH v2 09/10] Documentation: mainpage: Make it easier to\n\tdistinguish public and internal API","Message-ID":"<20250912172215.GC29172@pendragon.ideasonboard.com>","References":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>\n\t<20250911230115.25335-10-laurent.pinchart@ideasonboard.com>\n\t","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"","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\" "}}]