From patchwork Fri Dec 22 17:04:49 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 19343 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 999FEC3237 for ; Fri, 22 Dec 2023 17:05:08 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id E35C562B41; Fri, 22 Dec 2023 18:05:07 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1703264707; bh=b1rd4RvkMAFDUsc24zhOkyghunipsOieGGRrHDJOzQk=; h=To:Date:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=4gT3piYepQWSVppFySHXC4T2N5Mrk+o6edYTlCir0W0ZYQB7oDAORtiq3d3k4GDnj K5Ecn3gCkNI7m0yo2qWpU+xRLCYG0DeZpQThbnIfNMSROQPTCBQlC6tCxu918YcQCp taBxwzg1FmxlOqwXlBcIgoNiw4yi0C71hLgNKsjxgo6sSGXpNHLSZccHn03CepTKAz an4Rhccz9XYu900Lght9KQsPbEJWO2xSAbUtGLD2g7jwNQWToq0G3cGF9tWcSZYhZa 7+bu+L3ZbHnlkyDYz706yEpLNQJqUDBAEGXc6TXkPlmZY+Y9Ve9KujnLpAyROcKYTc k4ElUe2yu/Bvg== 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 8488D61D8F for ; Fri, 22 Dec 2023 18:05:06 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="lDAZ6zL2"; dkim-atps=neutral Received: from mail.ideasonboard.com (cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id B2DCC22A; Fri, 22 Dec 2023 18:04:14 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1703264654; bh=b1rd4RvkMAFDUsc24zhOkyghunipsOieGGRrHDJOzQk=; h=From:To:Cc:Subject:Date:From; b=lDAZ6zL2Ewt2HKN7AiqGZMGZ8mSfKs8RABPZw97uBG0YnaJhhZbmDwc0xoJOfX48P U3KQ/84c1nuVf4NGomQEYvlPynFtyGTaKcLH5jRBN6Nho4B300k+REsZVMeVFmLmGI jWFGs2c9Pw2vrWIXi59RJcpZHINAdloRDIwr/w4U= To: libcamera-devel@lists.libcamera.org Date: Fri, 22 Dec 2023 17:04:49 +0000 Message-Id: <20231222170449.794915-1-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] libcamera: Documentation: Improve doxygen main page 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: , X-Patchwork-Original-From: Daniel Scally via libcamera-devel From: Dan Scally Reply-To: Daniel Scally Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The "Main Page" of the doxygen generated API reference is currently totally empty. Expand it with some introductory text along with links to the developer's guide, application developer's guide and the pipeline and IPA module writer's guides. Provide an easy link to switch between the reduced public reference pages and the more complete internal ones. Signed-off-by: Daniel Scally --- This patch depends on "[PATCH 2/2] libcamera: Documentation: Split public/private documentation" Documentation/Doxyfile.in | 6 ++++-- Documentation/libcamera.dox | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 Documentation/libcamera.dox diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in index 6689ace1..1c6412ed 100644 --- a/Documentation/Doxyfile.in +++ b/Documentation/Doxyfile.in @@ -21,7 +21,8 @@ CASE_SENSE_NAMES = YES QUIET = YES -INPUT = "@TOP_SRCDIR@/include/libcamera" \ +INPUT = "@TOP_SRCDIR@/Documentation" \ + "@TOP_SRCDIR@/include/libcamera" \ "@TOP_SRCDIR@/src/ipa/ipu3" \ "@TOP_SRCDIR@/src/ipa/libipa" \ "@TOP_SRCDIR@/src/libcamera" \ @@ -30,7 +31,8 @@ INPUT = "@TOP_SRCDIR@/include/libcamera" \ FILE_PATTERNS = *.c \ *.cpp \ - *.h + *.h \ + *.dox RECURSIVE = YES diff --git a/Documentation/libcamera.dox b/Documentation/libcamera.dox new file mode 100644 index 00000000..c3101739 --- /dev/null +++ b/Documentation/libcamera.dox @@ -0,0 +1,33 @@ +/** +\mainpage libcamera API reference + +Welcome to the API reference for libcamera, +a complex camera support library for Linux, Android and ChromeOS. These pages do +not explain how to use libcamera to consume data from camera sensors in your +application, nor how to add support to the library for your hardware. There is +documentation available to detail how to achieve those things in detail, which +may be a better first contact with libcamera as a developer. As a starting +point we recommend the [developer's guide](../html/guides/introduction.html). + +As a follow-on to the developer's guide, if you wish add support for a new +platform the [pipeline handler writer's guide](../html/guides/pipeline-handler.html) +and the [ipa module writer's guide](../html/guides/ipa.html) should be helpful. +Alternatively if you are an application developer seeking to use libcamera within +your work the [application developer's guide](../html/guides/application-developer.html) +gives an overview on how to achieve that. + +\if internal + +If you are an application developer seeking to use libcamera with your program +then you may find it useful to use the [reduced version](../api-html/index.html) +of the API reference pages instead, which excludes library objects if they are +intended for internal use only. + +\else + +If you are a developer seeking to add support for your hardware to the library +or make other improvements, you should switch to the more complete internal API +[reference pages](../internal-api-html/index.html) instead + +\endif +*/