summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/stackallocator.c
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-27 17:21:23 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit9278f3d04f1e26071cb98a5e2940177abc40b6d8 (patch)
tree9f5d198e4af5ad22b96012a17ce0a23769acf01f /cpukit/score/src/stackallocator.c
parentrtems: Canonicalize Doxygen @file comments (diff)
downloadrtems-9278f3d04f1e26071cb98a5e2940177abc40b6d8.tar.bz2
score: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/score/src/stackallocator.c')
-rw-r--r--cpukit/score/src/stackallocator.c14
1 files changed, 12 insertions, 2 deletions
diff --git a/cpukit/score/src/stackallocator.c b/cpukit/score/src/stackallocator.c
index 6fd8bf9489..920aee86c1 100644
--- a/cpukit/score/src/stackallocator.c
+++ b/cpukit/score/src/stackallocator.c
@@ -1,6 +1,16 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreStack
*
+ * @brief This source file contains a definition of
+ * ::_Stack_Allocator_avoids_workspace and ::_Stack_Allocator_allocate which
+ * allocates the thread stacks from the RTEMS Workspace.
+ */
+
+/*
* Copyright (C) 2019 embedded brains GmbH
*
* Redistribution and use in source and binary forms, with or without