From patchwork Mon May 10 08:40:59 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Fancellu X-Patchwork-Id: 12247209 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 23818C433ED for ; Mon, 10 May 2021 08:41:38 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id AEEB9610CB for ; Mon, 10 May 2021 08:41:37 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org AEEB9610CB Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=arm.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from list by lists.xenproject.org with outflank-mailman.124962.235269 (Exim 4.92) (envelope-from ) id 1lg1Tm-00011R-Rs; Mon, 10 May 2021 08:41:30 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 124962.235269; Mon, 10 May 2021 08:41:30 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lg1Tm-00011E-O4; Mon, 10 May 2021 08:41:30 +0000 Received: by outflank-mailman (input) for mailman id 124962; Mon, 10 May 2021 08:41:29 +0000 Received: from all-amaz-eas1.inumbo.com ([34.197.232.57] helo=us1-amaz-eas2.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lg1Tl-0000ei-RX for xen-devel@lists.xenproject.org; Mon, 10 May 2021 08:41:29 +0000 Received: from foss.arm.com (unknown [217.140.110.172]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTP id 72a2a2b6-1ef0-48e9-b93f-c0a4888d172f; Mon, 10 May 2021 08:41:20 +0000 (UTC) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id C7828106F; Mon, 10 May 2021 01:41:19 -0700 (PDT) Received: from e125770.cambridge.arm.com (e125770.cambridge.arm.com [10.1.197.16]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 6041E3F719; Mon, 10 May 2021 01:41:18 -0700 (PDT) X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 72a2a2b6-1ef0-48e9-b93f-c0a4888d172f From: Luca Fancellu To: xen-devel@lists.xenproject.org Cc: bertrand.marquis@arm.com, wei.chen@arm.com, Andrew Cooper , George Dunlap , Ian Jackson , Jan Beulich , Julien Grall , Stefano Stabellini , Wei Liu Subject: [PATCH v6 3/9] docs: add doxygen templates Date: Mon, 10 May 2021 09:40:59 +0100 Message-Id: <20210510084105.17108-4-luca.fancellu@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210510084105.17108-1-luca.fancellu@arm.com> References: <20210510084105.17108-1-luca.fancellu@arm.com> Add doxygen templates for the doxygen documentation. Signed-off-by: Luca Fancellu Acked-by: Stefano Stabellini --- docs/xen-doxygen/customdoxygen.css | 36 +++++++++++++++++++ docs/xen-doxygen/footer.html | 21 +++++++++++ docs/xen-doxygen/header.html | 56 ++++++++++++++++++++++++++++++ docs/xen-doxygen/mainpage.md | 5 +++ 4 files changed, 118 insertions(+) create mode 100644 docs/xen-doxygen/customdoxygen.css create mode 100644 docs/xen-doxygen/footer.html create mode 100644 docs/xen-doxygen/header.html create mode 100644 docs/xen-doxygen/mainpage.md diff --git a/docs/xen-doxygen/customdoxygen.css b/docs/xen-doxygen/customdoxygen.css new file mode 100644 index 0000000000..4735e41cf5 --- /dev/null +++ b/docs/xen-doxygen/customdoxygen.css @@ -0,0 +1,36 @@ +/* Custom CSS for Doxygen-generated HTML + * Copyright (c) 2015 Intel Corporation + * SPDX-License-Identifier: Apache-2.0 + */ + +code { + font-family: Monaco,Menlo,Consolas,"Courier New",monospace; + background-color: #D8D8D8; + padding: 0 0.25em 0 0.25em; +} + +pre.fragment { + display: block; + font-family: Monaco,Menlo,Consolas,"Courier New",monospace; + padding: 1rem; + word-break: break-all; + word-wrap: break-word; + white-space: pre; + background-color: #D8D8D8; +} + +#projectlogo +{ + vertical-align: middle; +} + +#projectname +{ + font: 200% Tahoma, Arial,sans-serif; + color: #3D578C; +} + +#projectbrief +{ + color: #3D578C; +} diff --git a/docs/xen-doxygen/footer.html b/docs/xen-doxygen/footer.html new file mode 100644 index 0000000000..a24bf2b9b4 --- /dev/null +++ b/docs/xen-doxygen/footer.html @@ -0,0 +1,21 @@ + + + + + + + + + + diff --git a/docs/xen-doxygen/header.html b/docs/xen-doxygen/header.html new file mode 100644 index 0000000000..83ac2f1835 --- /dev/null +++ b/docs/xen-doxygen/header.html @@ -0,0 +1,56 @@ + + + + + + + + +$projectname: $title +$title + + + +$treeview +$search +$mathjax + +$extrastylesheet + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + +
+
$projectname +  $projectnumber +
+
$projectbrief
+
+
$projectbrief
+
$searchbox
+
+ + diff --git a/docs/xen-doxygen/mainpage.md b/docs/xen-doxygen/mainpage.md new file mode 100644 index 0000000000..ff548b87fc --- /dev/null +++ b/docs/xen-doxygen/mainpage.md @@ -0,0 +1,5 @@ +# API Documentation {#index} + +## Introduction + +## Licensing