[{"id":30803,"web_url":"https://patchwork.libcamera.org/comment/30803/","msgid":"<20240814011742.GL5833@pendragon.ideasonboard.com>","date":"2024-08-14T01:17:42","subject":"Re: [PATCH v7 4/5] Documentation: Improve doxygen main page","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Dan,\n\nThank you for the patch.\n\nOn Thu, Aug 08, 2024 at 03:09:47PM +0100, Daniel Scally wrote:\n> The \"Main Page\" of the doxygen generated API reference is currently\n> totally empty. Expand it with some introductory text along with links\n> to the developer's guide, application developer's guide and the\n> pipeline and IPA module writer's guides.\n> \n> Provide an easy link to switch between the reduced public reference\n> pages and the more complete internal ones.\n> \n> Reviewed-by: Jacopo Mondi \n> Reviewed-by: Kieran Bingham \n> Signed-off-by: Daniel Scally \n\nReviewed-by: Laurent Pinchart \n\n> ---\n> Changes since v6:\n> \n> \t- Addressed knock-on effect of patch #1 changes - no need to set the\n> \t ENABLED_SECTIONS in Doxyfiles anymore, as it was already done.\n> \n> Documentation/mainpage.dox | 33 +++++++++++++++++++++++++++++++++\n> 1 file changed, 33 insertions(+)\n> create mode 100644 Documentation/mainpage.dox\n> \n> diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\n> new file mode 100644\n> index 00000000..d5a57653\n> --- /dev/null\n> +++ b/Documentation/mainpage.dox\n> @@ -0,0 +1,33 @@\n> +/**\n> +\\mainpage libcamera API reference\n> +\n> +Welcome to the API reference for libcamera,\n> +a complex camera support library for Linux, Android and ChromeOS. These pages\n> +are automatically generated from the libcamera source code and describe the API\n> +in detail - if this is your first interaction with libcamera then you may find\n> +it useful to visit the [developer's guide](../html/guides/introduction.html) in\n> +the first instance, which can provide a more generic introduction to the\n> +library's concepts.\n> +\n> +\\if internal\n> +\n> +As a follow-on to the developer's guide, to assist you in adding support for\n> +your platform the [pipeline handler writer's guide](../html/guides/pipeline-handler.html)\n> +and the [ipa module writer's guide](../html/guides/ipa.html) should be helpful.\n> +\n> +The full libcamera API is documented here. If you wish to see only the public\n> +part of the API you can use [these pages](../api-html/index.html) instead.\n> +\n> +\\else\n> +\n> +As a follow-on to the developer's guide, to assist you in using libcamera within\n> +your project the [application developer's guide](../html/guides/application-developer.html)\n> +gives an overview on how to achieve that.\n> +\n> +Only the public part of the libcamera API is documented here; if you are a\n> +developer seeking to add support for your hardware to the library or make other\n> +improvements, you should switch to the internal API\n> +[reference pages](../internal-api-html/index.html) instead.\n> +\n> +\\endif\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 E8D5EC323E\n\tfor ;\n\tWed, 14 Aug 2024 01:18:09 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id DB734633B5;\n\tWed, 14 Aug 2024 03:18: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 4876063369\n\tfor ;\n\tWed, 14 Aug 2024 03:18:07 +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 ESMTPSA id 7AE113EA;\n\tWed, 14 Aug 2024 03:17:09 +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=\"Dfyn0LKV\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723598229;\n\tbh=NKnfWTgD7yt6bcA/Yfw8SlXPgnGhltJJJsPg6Qrxei4=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=Dfyn0LKVD/1y/KxWMuNBfIMFCFTBH7V+DWo618zRtBzmY179P7b8T+WfuXjFh1cQE\n\tI8y2fgRWxQLaIOpOJoTQLgFfiYkif3kpfExgOKUMiSh/tIi7g3QTa0usMhgincI5yL\n\tAraNAnkix3iL+FX8vWxn+vn5mOP685vCJcVOgqNY=","Date":"Wed, 14 Aug 2024 04:17:42 +0300","From":"Laurent Pinchart ","To":"Daniel Scally ","Cc":"libcamera-devel@lists.libcamera.org,\n\tJacopo Mondi ,\n\tKieran Bingham ","Subject":"Re: [PATCH v7 4/5] Documentation: Improve doxygen main page","Message-ID":"<20240814011742.GL5833@pendragon.ideasonboard.com>","References":"<20240808140948.430419-1-dan.scally@ideasonboard.com>\n\t<20240808140948.430419-5-dan.scally@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20240808140948.430419-5-dan.scally@ideasonboard.com>","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\" "}}]