From patchwork Mon Sep 8 14:07:48 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefan Klug X-Patchwork-Id: 24295 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 94EEDBDB13 for ; Mon, 8 Sep 2025 14:08:44 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 5C70369368; Mon, 8 Sep 2025 16:08:44 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="U5R8JymT"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id DC65169365 for ; Mon, 8 Sep 2025 16:08:42 +0200 (CEST) Received: from ideasonboard.com (unknown [IPv6:2a00:6020:448c:6c00:c241:40fd:9e5d:437c]) by perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 830782F0D; Mon, 8 Sep 2025 16:07:30 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1757340450; bh=ebuY38IcC+9G4wwQWEdlTE7fji8B+G/bENBNonDENSc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=U5R8JymTs7BpcsLtmZyPMUEKpwitX25X1kXRcLStT8sQNCkPQ9Qwky28Qtu1kwWkg xs30/iq0P62waCMHQpEtmvlf2i0t6IuBQLbPVFbWgAVOwyuS+L38gYSdSFohcx10Up DXsX9XBlGbUtKRY5FS0O6KaDGT7rHhPf6LOvmaGo= From: Stefan Klug To: libcamera-devel@lists.libcamera.org Cc: Stefan Klug Subject: [PATCH 5/6] documentation: mainpage: Make it easier to distinguish Public 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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" It might be confusion to customers to see very similar looking doxygen documentation with different content. Improve that by clearly stating 'Public-API' or 'Internal-API' on the main page. Signed-off-by: Stefan Klug --- Documentation/mainpage.dox | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox index cbee9bab12ec..3f9fa24c1e14 100644 --- a/Documentation/mainpage.dox +++ b/Documentation/mainpage.dox @@ -1,5 +1,9 @@ /** -\mainpage libcamera API reference +\if internal +\mainpage libcamera Internal-API reference +\else +\mainpage libcamera Public-API reference +\endif Welcome to the API reference for libcamera, a complex camera support library for Linux, Android and ChromeOS. These pages