From patchwork Thu Sep 11 23:01:10 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 24338 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 86625C324E for ; Thu, 11 Sep 2025 23:02:03 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 4A61769379; Fri, 12 Sep 2025 01:02:03 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="rRUItADQ"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 3B6AD69388 for ; Fri, 12 Sep 2025 01:02:00 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 2722646D5; Fri, 12 Sep 2025 01:00:45 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1757631645; bh=4jR90XIzCaeWUA00qHmGM+1zH9bKNiogEqRCRQCXTCE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=rRUItADQBCmcXj5IYixtZF26XMUiiOu8jXAAxCjbDsV+WOD4+xDxucl5uGLriu7ye jjEcv0qNYedgbLZnSYtjEHbvF3gE0y0MlSCS5I6Ylyt2JMo6clTCk0PrbKle6GNT7x 4WGH4gR5Wxb0lBnbDqDqWZDS0hlv1+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 distinguish 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 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" From: Stefan Klug 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 Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart Reviewed-by: Barnabás Pőcze --- Changes since v1: - Rename "libcamera Public-API reference" to "libcamera public API reference" (and same for the internal API) --- Documentation/mainpage.dox | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox index cbee9bab12ec..fae99f28f1af 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