[rtems-central commit] applconfig: Add Doxygen file to a group
Sebastian Huber
sebh at rtems.org
Thu Feb 16 08:06:08 UTC 2023
Module: rtems-central
Branch: master
Commit: 4099d9f59df08cc90e96adb1ea33df42cf83e6cc
Changeset: http://git.rtems.org/rtems-central/commit/?id=4099d9f59df08cc90e96adb1ea33df42cf83e6cc
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Thu Feb 16 08:59:19 2023 +0100
applconfig: Add Doxygen file to a group
---
rtemsspec/applconfig.py | 5 +++++
rtemsspec/tests/test_applconfig.py | 8 ++++++++
2 files changed, 13 insertions(+)
diff --git a/rtemsspec/applconfig.py b/rtemsspec/applconfig.py
index caef370a..132ee905 100644
--- a/rtemsspec/applconfig.py
+++ b/rtemsspec/applconfig.py
@@ -364,5 +364,10 @@ def generate(config: dict, group_uids: List[str],
sphinx_content.write(group_config["target"])
_generate(group, options, config["enabled-source"], doxygen_content)
doxygen_content.content.prepend_copyrights_and_licenses()
+ doxygen_content.content.prepend([
+ "/**", " * @file", " *", " * @ingroup RTEMSImplDoxygen", " *",
+ " * @brief This header file documents "
+ "the application configuration options.", " */", ""
+ ])
doxygen_content.content.prepend_spdx_license_identifier()
doxygen_content.write(config["doxygen-target"])
diff --git a/rtemsspec/tests/test_applconfig.py b/rtemsspec/tests/test_applconfig.py
index a6c11acc..5135cd5f 100644
--- a/rtemsspec/tests/test_applconfig.py
+++ b/rtemsspec/tests/test_applconfig.py
@@ -447,6 +447,14 @@ description m
with open(doxygen_h, "r") as src:
content = """/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file documents the application configuration options.
+ */
+
/*
* Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
*
More information about the vc
mailing list