Mirrors_Framework/rtems
1
0
Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2026-10-06 10:59:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

cpukit: Add the remaining Doxygen file headers

Browse Source 
Thirty-five files across the device drivers, the event recording, the
debugger interfaces, the flattened device tree support and several small
libraries had no Doxygen block.  Doxygen listed none of them.

Give each file a block with @file, @ingroup and @brief.  The brief names
what the file implements.

The score/cpu ports and the shell still lack their blocks.  Later
commits add them.

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:
Sebastian Huber
2026-09-01 20:17:20 +00:00
committed by Gedare Bloom
parent 8d1f0e5b59
commit 3f2e1bc22b
35 changed files with 310 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cpukit/dev/flash/flashdev.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSGenericFlashAPI
*
* @brief This source file contains the implementation of the generic flash
* device driver.
*/
/*
* Copyright (C) 2023 Aaron Nyholm
*
cpukit/dev/io/iodev.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSGenericIOSpaceAPI
*
* @brief This source file contains the implementation of the generic I/O
* device driver.
*/
/*
* Copyright (C) 2026 Aaron Nyholm
*
cpukit/dev/serial/sc16is752-regs.h
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup TermiostypesSupport
*
* @brief This header file provides the register definitions of the
* SC16IS752 serial device.
*/
/*
* Copyright (C) 2016 embedded brains GmbH & Co. KG
*
cpukit/dev/serial/sc16is752-spi.c
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup TermiostypesSupport
*
* @brief This source file contains the SPI attachment of the SC16IS752
* serial device driver.
*/
/*
* Copyright (C) 2016 embedded brains GmbH & Co. KG
*
cpukit/dev/serial/sc16is752.c
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup TermiostypesSupport
*
* @brief This source file contains the implementation of the SC16IS752
* serial device driver.
*/
/*
* Copyright (C) 2016 embedded brains GmbH & Co. KG
*
cpukit/ftpd/ftpd-init.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplFTPD
*
* @brief This source file contains the implementation of
* rtems_initialize_ftpd().
*/
/*
* Copyright (c) 2018 embedded brains GmbH & Co. KG
*
cpukit/include/dev/serial/sc16is752.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup TermiostypesSupport
*
* @brief This header file provides the interfaces of the SC16IS752 serial
* device driver.
*/
/*
* Copyright (c) 2016 embedded brains GmbH & Co. KG
*
cpukit/include/linux/rbtree.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplFreeBSDKernel
*
* @brief This header file provides the Linux red-black tree interfaces used
* by ported components.
*/
/*
* Copyright (c) 2015 embedded brains GmbH & Co. KG
*
cpukit/include/pci/ids.h
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This header file provides the PCI vendor and device identifiers.
*/
/*
* Copyright 1994, Drew Eckhardt
* Copyright 1997, 1998 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
cpukit/include/pci/pcireg.h
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup RTEMSImplPCI
*
* @brief This header file provides the PCI configuration space register
* definitions.
*/
/*-
* Copyright (c) 1997, Stefan Esser <se@freebsd.org>
* All rights reserved.
cpukit/include/rtems/debugger/rtems-debugger-bsp.h
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup RTEMSImplDebugger
*
* @brief This header file provides the BSP interfaces of the debugger
* server.
*/
/*
* Copyright (c) 2019 Chris Johns <chrisj@rtems.org>.
* All rights reserved.
cpukit/include/rtems/debugger/rtems-debugger-remote.h
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup RTEMSImplDebugger
*
* @brief This header file provides the remote transport interfaces of the
* debugger server.
*/
/*
* Copyright (c) 2016 Chris Johns <chrisj@rtems.org>.
* All rights reserved.
cpukit/include/rtems/debugger/rtems-debugger-server.h
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup RTEMSImplDebugger
*
* @brief This header file provides the server interfaces of the debugger
* server.
*/
/*
* Copyright (c) 2016-2019 Chris Johns <chrisj@rtems.org>.
* All rights reserved.
cpukit/include/rtems/jffs2.h
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup FileSystemTypesAndMount
*
* @brief This header file provides the interfaces of the JFFS2 file system.
*/
/*
* Copyright (C) 2013, 2016 embedded brains GmbH & Co. KG
*
cpukit/include/rtems/record.h
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplRecord
*
* @brief This header file provides the interfaces of the event recording.
*/
/*
* Copyright (C) 2018, 2024 embedded brains GmbH & Co. KG
*
cpukit/include/rtems/recordclient.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplRecord
*
* @brief This header file provides the interfaces of the event record
* client.
*/
/*
* Copyright (C) 2018, 2024 embedded brains GmbH & Co. KG
*
cpukit/include/rtems/recorddata.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplRecord
*
* @brief This header file provides the data definitions of the event
* recording.
*/
/*
* Copyright (C) 2018, 2024 embedded brains GmbH & Co. KG
*
cpukit/include/rtems/recorddump.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplRecord
*
* @brief This header file provides the interfaces which dump the event
* records.
*/
/*
* Copyright (C) 2020 embedded brains GmbH & Co. KG
*
cpukit/include/rtems/recordserver.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplRecord
*
* @brief This header file provides the interfaces of the event record
* server.
*/
/*
* Copyright (C) 2018, 2019 embedded brains GmbH & Co. KG
*
cpukit/include/rtems/rtems-debugger-remote-tcp.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplDebugger
*
* @brief This header file provides the interfaces of the TCP remote
* transport.
*/
/*
* Copyright (c) 2016 Chris Johns <chrisj@rtems.org>. All rights reserved.
*
cpukit/include/rtems/rtems-debugger.h
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplDebugger
*
* @brief This header file provides the interfaces of the debugger server.
*/
/*
* Copyright (c) 2016 Chris Johns <chrisj@rtems.org>. All rights reserved.
*
cpukit/include/rtems/rtl/dlfcn-shell.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup rtems_rtl
*
* @brief This header file provides the interfaces of the dlopen() shell
* command.
*/
/*
* COPYRIGHT (c) 2012 Chris Johns <chrisj@rtems.org>
*
cpukit/include/rtems/rtl/rap-shell.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup rtems_rap
*
* @brief This header file provides the interfaces of the RAP loader shell
* command.
*/
/*
* COPYRIGHT (c) 2013 Chris Johns <chrisj@rtems.org>
*
cpukit/include/rtems/stdio-redirect.h
+8
View File
@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup LibIO
*
* @brief This header file provides the interfaces of the stdio redirector.
*/
/*
* Copyright (c) 2014 Chris Johns <chrisj@rtems.org>. All rights reserved.
*
cpukit/libfs/src/imfs/imfs_make_linfile.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup IMFS
*
* @brief This source file contains the implementation of
* IMFS_make_linearfile().
*/
/*
* Copyright (C) 2019 embedded brains GmbH & Co. KG
*
cpukit/libgnat/ada_intrsupp.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplGnat
*
* @brief This source file contains the interrupt support of the Ada
* run-time.
*/
/*
* COPYRIGHT (c) 1989-2010.
* On-Line Applications Research Corporation (OAR).
cpukit/libi2c/libi2c.c
+9
View File
@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup libi2c
*
* @brief This source file contains the implementation of the legacy I2C
* library.
*/
/* libi2c Implementation */
/*
cpukit/libmisc/capture/rtems-trace-buffer-default.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplTrace
*
* @brief This source file contains the default trace buffer variables of
* the trace buffer generator.
*/
/*
* Copyright (c) 2015 Chris Johns <chrisj@rtems.org>
*
cpukit/libmisc/capture/rtems-trace-buffer-vars.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplTrace
*
* @brief This source file contains the implementation which reads the trace
* buffer variables.
*/
/*
* Copyright (c) 2015 Chris Johns <chrisj@rtems.org>
*
cpukit/libmisc/cpuuse/cpuinforeport.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplCPUUsageReporting
*
* @brief This source file contains the implementation of
* rtems_cpu_info_report().
*/
/*
* Copyright (c) 2016 embedded brains GmbH & Co. KG
*
cpukit/libmisc/dummy/default-configuration.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplApplConfig
*
* @brief This source file contains a default application configuration for
* link tests.
*/
/*
* Default configuration file
*
cpukit/libmisc/rtems-fdt/rtems-fdt.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplFDT
*
* @brief This source file contains the implementation of the flattened
* device tree support.
*/
/*
* COPYRIGHT (c) 2013-2017 Chris Johns <chrisj@rtems.org>
*
cpukit/libmisc/stringto/stringto_template.h
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplStringConversion
*
* @brief This header file provides the template of the string conversion
* functions.
*/
/*
* Copyright (c) 2009 On-Line Applications Research Corporation (OAR).
*
cpukit/libmisc/untar/untar_tgz.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup libmisc_untar_img
*
* @brief This source file contains the implementation which untars a gzip
* compressed archive.
*/
/*
* Copyright (c) 2016 embedded brains GmbH & Co. KG
*
cpukit/libmisc/untar/untar_txz.c
+9
View File
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup libmisc_untar_img
*
* @brief This source file contains the implementation which untars an xz
* compressed archive.
*/
/*
* Copyright (c) 2016 Chris Johns <chrisj.rtems.org>. All rights reserved.
*