spec: Add header file brief descriptions

31 files changed, 37 insertions, 0 deletions

diff --git a/spec/if/rtems/attr/header.yml b/spec/if/rtems/attr/header.yml
index 06680c9f..1ef0839a 100644
--- a/spec/if/rtems/attr/header.yml
+++ b/spec/if/rtems/attr/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines attributes provided by the API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/barrier/header.yml b/spec/if/rtems/barrier/header.yml
index 4bc5040b..fc76a102 100644
--- a/spec/if/rtems/barrier/header.yml
+++ b/spec/if/rtems/barrier/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Barrier Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/basedefs/header.yml b/spec/if/rtems/basedefs/header.yml
index 6d5c5d26..0fe9a823 100644
--- a/spec/if/rtems/basedefs/header.yml
+++ b/spec/if/rtems/basedefs/header.yml
@@ -1,4 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This header file provides basic definitions used by the API and
+  the implementation.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/cache/header.yml b/spec/if/rtems/cache/header.yml
index ae962263..e84b4f5e 100644
--- a/spec/if/rtems/cache/header.yml
+++ b/spec/if/rtems/cache/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Cache Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/clock/header.yml b/spec/if/rtems/clock/header.yml
index 1ef5b5c3..f402e692 100644
--- a/spec/if/rtems/clock/header.yml
+++ b/spec/if/rtems/clock/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Clock Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/config/header-2.yml b/spec/if/rtems/config/header-2.yml
index b06134c2..99bebfc7 100644
--- a/spec/if/rtems/config/header-2.yml
+++ b/spec/if/rtems/config/header-2.yml
@@ -1,4 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This header file defines parts of the application configuration information
+  API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/config/header.yml b/spec/if/rtems/config/header.yml
index 0aef288f..dcaddd45 100644
--- a/spec/if/rtems/config/header.yml
+++ b/spec/if/rtems/config/header.yml
@@ -1,4 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This header file defines parts of the application configuration information
+  API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/dpmem/header.yml b/spec/if/rtems/dpmem/header.yml
index 9df2a09a..5aa6b51a 100644
--- a/spec/if/rtems/dpmem/header.yml
+++ b/spec/if/rtems/dpmem/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Dual-Ported Memory Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/event/header.yml b/spec/if/rtems/event/header.yml
index 3a4f1e81..eff99c1d 100644
--- a/spec/if/rtems/event/header.yml
+++ b/spec/if/rtems/event/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Event Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/fatal/header.yml b/spec/if/rtems/fatal/header.yml
index 28c2a03e..6fbe3be5 100644
--- a/spec/if/rtems/fatal/header.yml
+++ b/spec/if/rtems/fatal/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Fatal Error Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/header.yml b/spec/if/rtems/header.yml
index ade7cbac..2ce3fbd9 100644
--- a/spec/if/rtems/header.yml
+++ b/spec/if/rtems/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Classic API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/init/header.yml b/spec/if/rtems/init/header.yml
index 7ddadca7..b2228785 100644
--- a/spec/if/rtems/init/header.yml
+++ b/spec/if/rtems/init/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Initialization Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/intr/header.yml b/spec/if/rtems/intr/header.yml
index 04de993a..1a3e0755 100644
--- a/spec/if/rtems/intr/header.yml
+++ b/spec/if/rtems/intr/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Interrupt Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/io/header.yml b/spec/if/rtems/io/header.yml
index 18bea8e2..c8175914 100644
--- a/spec/if/rtems/io/header.yml
+++ b/spec/if/rtems/io/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the IO Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/message/header.yml b/spec/if/rtems/message/header.yml
index 7b11b999..2dba7f70 100644
--- a/spec/if/rtems/message/header.yml
+++ b/spec/if/rtems/message/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Message Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/modes/header.yml b/spec/if/rtems/modes/header.yml
index 1cd9e781..e6e694d8 100644
--- a/spec/if/rtems/modes/header.yml
+++ b/spec/if/rtems/modes/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the task modes of the Task Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/mp/header.yml b/spec/if/rtems/mp/header.yml
index 1555c51f..95a9b92f 100644
--- a/spec/if/rtems/mp/header.yml
+++ b/spec/if/rtems/mp/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Multiprocessing Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/object/header.yml b/spec/if/rtems/object/header.yml
index 09d82dcb..8b90b787 100644
--- a/spec/if/rtems/object/header.yml
+++ b/spec/if/rtems/object/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Object Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/options/header.yml b/spec/if/rtems/options/header.yml
index 7a697a16..93c7087f 100644
--- a/spec/if/rtems/options/header.yml
+++ b/spec/if/rtems/options/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines options provided by the API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/part/header.yml b/spec/if/rtems/part/header.yml
index 52671a7d..8bd8a5f4 100644
--- a/spec/if/rtems/part/header.yml
+++ b/spec/if/rtems/part/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Partition Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/ratemon/header.yml b/spec/if/rtems/ratemon/header.yml
index dc566451..f6d0236f 100644
--- a/spec/if/rtems/ratemon/header.yml
+++ b/spec/if/rtems/ratemon/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Rate-Monotonic Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/region/header.yml b/spec/if/rtems/region/header.yml
index 06949537..0463cc18 100644
--- a/spec/if/rtems/region/header.yml
+++ b/spec/if/rtems/region/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Region Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/sem/header.yml b/spec/if/rtems/sem/header.yml
index 65be6db2..1e7c2c9b 100644
--- a/spec/if/rtems/sem/header.yml
+++ b/spec/if/rtems/sem/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Semaphore Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/signal/header-2.yml b/spec/if/rtems/signal/header-2.yml
index 59c98296..6e6a854f 100644
--- a/spec/if/rtems/signal/header-2.yml
+++ b/spec/if/rtems/signal/header-2.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the parts of the Signal Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/signal/header.yml b/spec/if/rtems/signal/header.yml
index c1c3f0c8..4f2ca30c 100644
--- a/spec/if/rtems/signal/header.yml
+++ b/spec/if/rtems/signal/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the parts of the Signal Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/status/header.yml b/spec/if/rtems/status/header.yml
index 63610f04..83cb2b38 100644
--- a/spec/if/rtems/status/header.yml
+++ b/spec/if/rtems/status/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the status codes provided by API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/support/header.yml b/spec/if/rtems/support/header.yml
index 5bdd2dcb..f21a705c 100644
--- a/spec/if/rtems/support/header.yml
+++ b/spec/if/rtems/support/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines support services of the API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/tasks/header.yml b/spec/if/rtems/tasks/header.yml
index ff75781a..2f0d15b5 100644
--- a/spec/if/rtems/tasks/header.yml
+++ b/spec/if/rtems/tasks/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the main parts of the Tasks Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/timer/header.yml b/spec/if/rtems/timer/header.yml
index 0200be2e..aee0329a 100644
--- a/spec/if/rtems/timer/header.yml
+++ b/spec/if/rtems/timer/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the Timer Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/types/header.yml b/spec/if/rtems/types/header.yml
index 9f00af97..3a6774a1 100644
--- a/spec/if/rtems/types/header.yml
+++ b/spec/if/rtems/types/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines types provided by the API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/if/rtems/userext/header.yml b/spec/if/rtems/userext/header.yml
index eb68a9a1..f0d29cfa 100644
--- a/spec/if/rtems/userext/header.yml
+++ b/spec/if/rtems/userext/header.yml
@@ -1,4 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the User Extensions Manager API.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true