{"id":24338,"url":"https://patchwork.libcamera.org/api/patches/24338/?format=json","web_url":"https://patchwork.libcamera.org/patch/24338/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20250911230115.25335-10-laurent.pinchart@ideasonboard.com>","date":"2025-09-11T23:01:10","name":"[v2,09/10] Documentation: mainpage: Make it easier to distinguish public and internal API","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"a5350950298a0c1fd12fc731d20b72a946b0243f","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/24338/mbox/","series":[{"id":5435,"url":"https://patchwork.libcamera.org/api/series/5435/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5435","date":"2025-09-11T23:01:01","name":"Documentation theming update","version":2,"mbox":"https://patchwork.libcamera.org/series/5435/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/24338/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/24338/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 86625C324E\n\tfor ;\n\tThu, 11 Sep 2025 23:02:03 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 4A61769379;\n\tFri, 12 Sep 2025 01:02:03 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 3B6AD69388\n\tfor ;\n\tFri, 12 Sep 2025 01:02:00 +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 2722646D5; \n\tFri, 12 Sep 2025 01:00:45 +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=\"rRUItADQ\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757631645;\n\tbh=4jR90XIzCaeWUA00qHmGM+1zH9bKNiogEqRCRQCXTCE=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=rRUItADQBCmcXj5IYixtZF26XMUiiOu8jXAAxCjbDsV+WOD4+xDxucl5uGLriu7ye\n\tjjEcv0qNYedgbLZnSYtjEHbvF3gE0y0MlSCS5I6Ylyt2JMo6clTCk0PrbKle6GNT7x\n\t4WGH4gR5Wxb0lBnbDqDqWZDS0hlv1+OH/qPKpbkU=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Cc":"Stefan Klug ","Subject":"[PATCH v2 09/10] Documentation: mainpage: Make it easier to\n\tdistinguish public and internal API","Date":"Fri, 12 Sep 2025 02:01:10 +0300","Message-ID":"<20250911230115.25335-10-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.49.1","In-Reply-To":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>","References":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","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\" "},"content":"From: Stefan Klug \n\nIt might be confusion to customers to see very similar looking doxygen\ndocumentation with different content. Improve that by clearly stating\n'public API' or 'internal API' on the main page.\n\nSigned-off-by: Stefan Klug \nReviewed-by: Laurent Pinchart \nSigned-off-by: Laurent Pinchart \n---\nChanges 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(-)","diff":"diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\nindex 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\n","prefixes":["v2","09/10"]}