Exclude copyright notices from Doxygen file descriptions.

This commit is contained in:
Martin Whitaker 2022-02-19 19:56:55 +00:00
parent d04ec9f681
commit f8b82eb0bd
43 changed files with 43 additions and 0 deletions

View File

@ -6,6 +6,7 @@
*
* Provides functions for generating patterns for the Linux kernel BadRAM extension.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides the configuration settings and pop-up menu.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides (macro) functions that implement the UI display.
* All knowledge about the display layout is encapsulated here.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides functions that can be called by the memory tests to report errors.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides the interrupt handler.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides types and variables used when performing the memory tests.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides definitions used in the boot code. Also defines exported symbols
* needed in the main code.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -9,6 +9,7 @@
* the Linux boot_params struct, although we only define the fields we are
* interested in.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides definitions for accessing the UEFI boot services and configuration
* tables.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a barrier synchronisation primitive.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a subset of the functions normally provided by <ctype.h>.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides functions to print strings and formatted values to the screen.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a function to read a numeric value.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a lightweight mutex synchronisation primitive.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a subset of the functions normally provided by <string.h>.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a subset of the functions normally provided by <unistd.h>.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides functions to enable, disable, and flush the CPU caches.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides access to the CPUID information.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*
* Derived from memtest86+ cpuid.h

View File

@ -6,6 +6,7 @@
*
* Provides information about the CPU type, clock speed and cache sizes.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides support for USB keyboards connected via an EHCI controller.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides the font used for framebuffer display.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides miscellaneous hardware control functions.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -15,6 +15,7 @@
* over and over again with slight variations and possibly making a
* mistake somewhere.
*
*//*
* Derived from memtest86+ io.h.
* (original contained no copyright statement)
*/

View File

@ -7,6 +7,7 @@
* Provides the keyboard interface. It converts incoming key codes to
* ASCII characters.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -8,6 +8,7 @@
* optimizing accesses which need to be ordered and atomic. Mostly used
* for accessing memory-mapped hardware registers.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -8,6 +8,7 @@
* optimizing accesses which need to be ordered and atomic. Mostly used
* for accessing memory-mapped hardware registers.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides some convenient constants and constant constructors.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides access to the CPU machine-specific registers.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides support for USB keyboards connected via an OHCI controller.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides functions to perform PCI configuration space reads and writes.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a description of the system physical memory map.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides the display interface. It provides an 80x25 VGA-compatible text
* display.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides support for multi-threaded operation.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides a function to read the CPU core temperature.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides access to the CPU timestamp counter.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides support for USB keyboards connected via an UHCI controller.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides definitions of various values and data structures defined by the
* USB specifications.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -18,6 +18,7 @@
* in the private usb_controllers table, where it can subsequently used
* to poll the keyboards for key presses.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides functions to handle physical memory page mapping into virtual
* memory.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides support for USB keyboards connected via an XHCI controller.
*
*//*
* Copyright (C) 2021-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides the prototypes for the basic test functions used to implement
* the tests.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -7,6 +7,7 @@
* Provides some common definitions and helper functions for the memory
* tests.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/

View File

@ -6,6 +6,7 @@
*
* Provides support for identifying and running the memory tests.
*
*//*
* Copyright (C) 2020-2022 Martin Whitaker.
*/