{"id":24295,"url":"https://patchwork.libcamera.org/api/1.1/patches/24295/?format=json","web_url":"https://patchwork.libcamera.org/patch/24295/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20250908140803.123272-6-stefan.klug@ideasonboard.com>","date":"2025-09-08T14:07:48","name":"[5/6] documentation: mainpage: Make it easier to distinguish Public and Internal API","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"75a80638b915deed03566ff6024aec7ff19db57f","submitter":{"id":184,"url":"https://patchwork.libcamera.org/api/1.1/people/184/?format=json","name":"Stefan Klug","email":"stefan.klug@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/24295/mbox/","series":[{"id":5424,"url":"https://patchwork.libcamera.org/api/1.1/series/5424/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5424","date":"2025-09-08T14:07:43","name":"Documentation theming update","version":1,"mbox":"https://patchwork.libcamera.org/series/5424/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/24295/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/24295/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 94EEDBDB13\n\tfor ;\n\tMon, 8 Sep 2025 14:08:44 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 5C70369368;\n\tMon, 8 Sep 2025 16:08:44 +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 DC65169365\n\tfor ;\n\tMon, 8 Sep 2025 16:08:42 +0200 (CEST)","from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:c241:40fd:9e5d:437c])\n\tby perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 830782F0D; \n\tMon, 8 Sep 2025 16:07:30 +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=\"U5R8JymT\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757340450;\n\tbh=ebuY38IcC+9G4wwQWEdlTE7fji8B+G/bENBNonDENSc=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=U5R8JymTs7BpcsLtmZyPMUEKpwitX25X1kXRcLStT8sQNCkPQ9Qwky28Qtu1kwWkg\n\txs30/iq0P62waCMHQpEtmvlf2i0t6IuBQLbPVFbWgAVOwyuS+L38gYSdSFohcx10Up\n\tDXsX9XBlGbUtKRY5FS0O6KaDGT7rHhPf6LOvmaGo=","From":"Stefan Klug ","To":"libcamera-devel@lists.libcamera.org","Cc":"Stefan Klug ","Subject":"[PATCH 5/6] documentation: mainpage: Make it easier to distinguish\n\tPublic and Internal API","Date":"Mon, 8 Sep 2025 16:07:48 +0200","Message-ID":"<20250908140803.123272-6-stefan.klug@ideasonboard.com>","X-Mailer":"git-send-email 2.48.1","In-Reply-To":"<20250908140803.123272-1-stefan.klug@ideasonboard.com>","References":"<20250908140803.123272-1-stefan.klug@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":"It 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 \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..3f9fa24c1e14 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":["5/6"]}