[PATCH] doxgen: Document build system provided files

Sebastian Huber sebastian.huber at embedded-brains.de
Thu Jul 20 13:20:04 UTC 2023


Update #3707.
---
 cpukit/doxygen/build.h | 82 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 cpukit/doxygen/build.h

diff --git a/cpukit/doxygen/build.h b/cpukit/doxygen/build.h
new file mode 100644
index 0000000000..e76c173eb8
--- /dev/null
+++ b/cpukit/doxygen/build.h
@@ -0,0 +1,82 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplDoxygen
+ *
+ * @brief This header file defines build system related Doxygen items.
+ */
+
+/*
+ * Copyright (C) 2023 embedded brains GmbH (http://www.embedded-brains.de)
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @defgroup RTEMSImplBuild Build Options
+ *
+ * @ingroup RTEMSImpl
+ *
+ * @brief This group contains files provided by the build system.
+ */
+
+/**
+ * @ingroup RTEMSImplBuild
+ *
+ * @file bsps/include/bspopts.h
+ *
+ * @brief This header file provides the BSP options definitions.
+ */
+
+/**
+ * @ingroup RTEMSImplBuild
+ *
+ * @file cpukit/include/version-vc-key.h
+ *
+ * @brief This header file provides the version control key definitions.
+ */
+
+/**
+ * @ingroup RTEMSImplBuild
+ *
+ * @file cpukit/include/config.h
+ *
+ * @brief This header file provides system configuration definitions.
+ */
+
+/**
+ * @ingroup RTEMSImplBuild
+ *
+ * @file cpukit/include/rtems/testopts.h
+ *
+ * @brief This header file provides test program definitions.
+ */
+
+/**
+ * @ingroup RTEMSImplBuild
+ *
+ * @file cpukit/include/rtems/score/cpuopts.h
+ *
+ * @brief This header file provides the CPU options definitions.
+ */
-- 
2.35.3



More information about the devel mailing list