mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-10-06 10:59:48 +08:00
cpukit/libcsupport: Add the Doxygen file headers
Thirty files in libcsupport had no Doxygen block. Doxygen listed none of them, so the malloc support, the simple console driver and the printer had gaps in their pages. Give each file a block with @file, @ingroup and @brief. The brief names what the file implements. Updates #5717. Assisted-by: Claude:claude-opus-5 claude-code Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
This commit is contained in:
committed by
Gedare Bloom
parent
535009c79d
commit
8d1f0e5b59
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup MallocSupport
|
||||
*
|
||||
* @brief This source file contains the implementation of _malloc_r().
|
||||
*/
|
||||
|
||||
/*
|
||||
* _malloc_r Implementation
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup MallocSupport
|
||||
*
|
||||
* @brief This source file contains the implementation of aligned_alloc()
|
||||
* and memalign().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2018 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of
|
||||
* _arc4random_getentropy_fail().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2017 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplAssociativity
|
||||
*
|
||||
* @brief This source file contains the implementation of
|
||||
* rtems_assoc_32_to_string().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2016 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplAssociativity
|
||||
*
|
||||
* @brief This source file contains the implementation of
|
||||
* rtems_assoc_thread_states_to_string().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2016 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of clock().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2017 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup Termios
|
||||
*
|
||||
* @brief This source file contains the implementation of the simple console
|
||||
* driver.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2017, 2020 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup Termios
|
||||
*
|
||||
* @brief This header file provides the interfaces of the simple console
|
||||
* driver.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2018 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup Termios
|
||||
*
|
||||
* @brief This source file contains the read support of the simple console
|
||||
* driver.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2017 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup Termios
|
||||
*
|
||||
* @brief This source file contains the task driven variant of the simple
|
||||
* console driver.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2018, 2020 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIO
|
||||
*
|
||||
* @brief This source file contains the implementation of fstat().
|
||||
*/
|
||||
|
||||
/*
|
||||
* fstat() - POSIX 1003.1b 5.6.2 - Get File Status
|
||||
*
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of ftrylockfile().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2009 by
|
||||
* Ralf Corsepius, Ulm, Germany. All rights reserved.
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of __getreent().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2018 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of getrusage().
|
||||
*/
|
||||
|
||||
/*
|
||||
* COPYRIGHT (c) 1989-2010.
|
||||
* On-Line Applications Research Corporation (OAR).
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: GPL-2.0-with-RTEMS-exception */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of lchown().
|
||||
*/
|
||||
|
||||
/*
|
||||
* lchown() - POSIX 1003.1b 5.6.5 - Change Owner and Group of a File
|
||||
* But Do Not Follow a Symlink
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup MallocSupport
|
||||
*
|
||||
* @brief This source file contains the default implementation which dirties
|
||||
* the allocated memory.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2020 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup MallocSupport
|
||||
*
|
||||
* @brief This source file contains the default implementation which extends
|
||||
* the heap of the allocator.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2020 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup FileSystemTypesAndMount
|
||||
*
|
||||
* @brief This source file contains the implementation of the file system
|
||||
* type registry.
|
||||
*/
|
||||
|
||||
/*
|
||||
* mount()
|
||||
*
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: GPL-2.0-with-RTEMS-exception */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of _exit().
|
||||
*/
|
||||
|
||||
/*
|
||||
* COPYRIGHT (c) 1994 by Division Incorporated
|
||||
*
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of posix_devctl().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2016, 2020 Joel Sherrill <joel@rtems.org>.
|
||||
* All rights reserved.
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPrintSupport
|
||||
*
|
||||
* @brief This source file contains the implementation of the printer which
|
||||
* uses fprintf().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2017 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RTEMSImplPrintSupport
|
||||
*
|
||||
* @brief This source file contains the implementation of the task driven
|
||||
* printer.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2016 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This header file provides the internal interfaces of the password
|
||||
* and group file support.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2014 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of the resource
|
||||
* snapshot support.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2012, 2014 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup MallocSupport
|
||||
*
|
||||
* @brief This source file contains the implementation of
|
||||
* rtems_heap_null_extend().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2012 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of setgroups().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2016 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
* @brief This source file contains the implementation of setuid().
|
||||
*/
|
||||
|
||||
/*
|
||||
* COPYRIGHT (c) 1989-2010.
|
||||
* On-Line Applications Research Corporation (OAR).
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIO
|
||||
*
|
||||
* @brief This source file contains the implementation of statvfs().
|
||||
*/
|
||||
|
||||
/*
|
||||
* COPYRIGHT (c) 2009 Chris Johns <chrisj@rtems.org>
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup Termios
|
||||
*
|
||||
* @brief This source file contains the implementation of
|
||||
* rtems_termios_set_best_baud().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2014 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup LibIOEnv
|
||||
*
|
||||
* @brief This source file contains the implementation of
|
||||
* rtems_current_user_env_getgroups().
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2014 embedded brains GmbH & Co. KG
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user