From patchwork Wed Sep 17 20:17:40 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 24387 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 6DD93C328C for ; Wed, 17 Sep 2025 20:18:38 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id A844169381; Wed, 17 Sep 2025 22:18:37 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="t9cS3OQY"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id E985669369 for ; Wed, 17 Sep 2025 22:18:26 +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 C450A6A8; Wed, 17 Sep 2025 22:17:07 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1758140227; bh=NAlzJuLQAFRATtLdg7JIf5rfGFthI/BnLoLcCzPeGzE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=t9cS3OQYXrX6qPqzcbrmgNs3465wjMMUG5gThHK6STBokpw/PkaMpMdKwRLrAMvCK gqOsqrfEqUGz3kyBsa1FxVMs8YuUtlbdhhvqpSuKxlY8we9hepmk4DnzczRthdAgiP X6T25goKrpdDigr/+WrWAtSlkyVhxisxwp9rNeOY= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Cc: Stefan Klug Subject: [PATCH v3 09/10] Documentation: mainpage: Make it easier to distinguish public and internal API Date: Wed, 17 Sep 2025 23:17:40 +0300 Message-ID: <20250917201742.16406-10-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.49.1 In-Reply-To: <20250917201742.16406-1-laurent.pinchart@ideasonboard.com> References: <20250917201742.16406-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 confusing to consumers 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 v2: - Fix typos in commit message 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