From f8b82eb0bd2c19136fa6da254cac22d2d2b0cba6 Mon Sep 17 00:00:00 2001 From: Martin Whitaker Date: Sat, 19 Feb 2022 19:56:55 +0000 Subject: [PATCH] Exclude copyright notices from Doxygen file descriptions. --- app/badram.h | 1 + app/config.h | 1 + app/display.h | 1 + app/error.h | 1 + app/interrupt.h | 1 + app/test.h | 1 + boot/boot.h | 1 + boot/bootparams.h | 1 + boot/efi.h | 1 + lib/barrier.h | 1 + lib/ctype.h | 1 + lib/print.h | 1 + lib/read.h | 1 + lib/spinlock.h | 1 + lib/string.h | 1 + lib/unistd.h | 1 + system/cache.h | 1 + system/cpuid.h | 1 + system/cpuinfo.h | 1 + system/ehci.h | 1 + system/font.h | 1 + system/hwctrl.h | 1 + system/io.h | 1 + system/keyboard.h | 1 + system/memrw32.h | 1 + system/memrw64.h | 1 + system/memsize.h | 1 + system/msr.h | 1 + system/ohci.h | 1 + system/pci.h | 1 + system/pmem.h | 1 + system/screen.h | 1 + system/smp.h | 1 + system/temperature.h | 1 + system/tsc.h | 1 + system/uhci.h | 1 + system/usb.h | 1 + system/usbhcd.h | 1 + system/vmem.h | 1 + system/xhci.h | 1 + tests/test_funcs.h | 1 + tests/test_helper.h | 1 + tests/tests.h | 1 + 43 files changed, 43 insertions(+) diff --git a/app/badram.h b/app/badram.h index 9c6bf9d..db450cf 100644 --- a/app/badram.h +++ b/app/badram.h @@ -6,6 +6,7 @@ * * Provides functions for generating patterns for the Linux kernel BadRAM extension. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/app/config.h b/app/config.h index 3aa7f1f..5619cb5 100644 --- a/app/config.h +++ b/app/config.h @@ -6,6 +6,7 @@ * * Provides the configuration settings and pop-up menu. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/app/display.h b/app/display.h index ef737d0..e952f8b 100644 --- a/app/display.h +++ b/app/display.h @@ -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. */ diff --git a/app/error.h b/app/error.h index 89103c5..a564ba0 100644 --- a/app/error.h +++ b/app/error.h @@ -6,6 +6,7 @@ * * Provides functions that can be called by the memory tests to report errors. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/app/interrupt.h b/app/interrupt.h index 518aaca..a0fc93d 100644 --- a/app/interrupt.h +++ b/app/interrupt.h @@ -6,6 +6,7 @@ * * Provides the interrupt handler. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/app/test.h b/app/test.h index c901ca6..77425c0 100644 --- a/app/test.h +++ b/app/test.h @@ -6,6 +6,7 @@ * * Provides types and variables used when performing the memory tests. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/boot/boot.h b/boot/boot.h index 9566d0f..702f3ac 100644 --- a/boot/boot.h +++ b/boot/boot.h @@ -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. */ diff --git a/boot/bootparams.h b/boot/bootparams.h index 6b891cd..49ec96c 100644 --- a/boot/bootparams.h +++ b/boot/bootparams.h @@ -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. */ diff --git a/boot/efi.h b/boot/efi.h index 7548705..c4b3dcd 100644 --- a/boot/efi.h +++ b/boot/efi.h @@ -7,6 +7,7 @@ * Provides definitions for accessing the UEFI boot services and configuration * tables. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/lib/barrier.h b/lib/barrier.h index ed97bac..a0c3d2d 100644 --- a/lib/barrier.h +++ b/lib/barrier.h @@ -6,6 +6,7 @@ * * Provides a barrier synchronisation primitive. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/lib/ctype.h b/lib/ctype.h index b0dabd1..f153018 100644 --- a/lib/ctype.h +++ b/lib/ctype.h @@ -6,6 +6,7 @@ * * Provides a subset of the functions normally provided by . * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/lib/print.h b/lib/print.h index 520f99f..f07502a 100644 --- a/lib/print.h +++ b/lib/print.h @@ -6,6 +6,7 @@ * * Provides functions to print strings and formatted values to the screen. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/lib/read.h b/lib/read.h index 32b36af..c416246 100644 --- a/lib/read.h +++ b/lib/read.h @@ -6,6 +6,7 @@ * * Provides a function to read a numeric value. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/lib/spinlock.h b/lib/spinlock.h index 7866f1e..4e443d4 100644 --- a/lib/spinlock.h +++ b/lib/spinlock.h @@ -6,6 +6,7 @@ * * Provides a lightweight mutex synchronisation primitive. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/lib/string.h b/lib/string.h index 5d2b7eb..1ac7c25 100644 --- a/lib/string.h +++ b/lib/string.h @@ -6,6 +6,7 @@ * * Provides a subset of the functions normally provided by . * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/lib/unistd.h b/lib/unistd.h index b485428..8756984 100644 --- a/lib/unistd.h +++ b/lib/unistd.h @@ -6,6 +6,7 @@ * * Provides a subset of the functions normally provided by . * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/cache.h b/system/cache.h index 2a1c38b..3ec7438 100644 --- a/system/cache.h +++ b/system/cache.h @@ -6,6 +6,7 @@ * * Provides functions to enable, disable, and flush the CPU caches. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/cpuid.h b/system/cpuid.h index db44eb1..de4ced0 100644 --- a/system/cpuid.h +++ b/system/cpuid.h @@ -6,6 +6,7 @@ * * Provides access to the CPUID information. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. * * Derived from memtest86+ cpuid.h diff --git a/system/cpuinfo.h b/system/cpuinfo.h index 9df5aac..7f33af3 100644 --- a/system/cpuinfo.h +++ b/system/cpuinfo.h @@ -6,6 +6,7 @@ * * Provides information about the CPU type, clock speed and cache sizes. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/ehci.h b/system/ehci.h index 1b4fecf..aef36b1 100644 --- a/system/ehci.h +++ b/system/ehci.h @@ -6,6 +6,7 @@ * * Provides support for USB keyboards connected via an EHCI controller. * + *//* * Copyright (C) 2021-2022 Martin Whitaker. */ diff --git a/system/font.h b/system/font.h index 7a0d9b7..6134ec4 100644 --- a/system/font.h +++ b/system/font.h @@ -6,6 +6,7 @@ * * Provides the font used for framebuffer display. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/hwctrl.h b/system/hwctrl.h index c4efc45..c70c2a6 100644 --- a/system/hwctrl.h +++ b/system/hwctrl.h @@ -6,6 +6,7 @@ * * Provides miscellaneous hardware control functions. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/io.h b/system/io.h index aa3e3ad..c9cb1b4 100644 --- a/system/io.h +++ b/system/io.h @@ -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) */ diff --git a/system/keyboard.h b/system/keyboard.h index 212e5bf..049336a 100644 --- a/system/keyboard.h +++ b/system/keyboard.h @@ -7,6 +7,7 @@ * Provides the keyboard interface. It converts incoming key codes to * ASCII characters. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/memrw32.h b/system/memrw32.h index af7cab2..e9316ec 100644 --- a/system/memrw32.h +++ b/system/memrw32.h @@ -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. */ diff --git a/system/memrw64.h b/system/memrw64.h index 235b602..f45d36b 100644 --- a/system/memrw64.h +++ b/system/memrw64.h @@ -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. */ diff --git a/system/memsize.h b/system/memsize.h index bdf3b4f..10a1cf1 100644 --- a/system/memsize.h +++ b/system/memsize.h @@ -6,6 +6,7 @@ * * Provides some convenient constants and constant constructors. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/msr.h b/system/msr.h index 6f4089c..167cf72 100644 --- a/system/msr.h +++ b/system/msr.h @@ -6,6 +6,7 @@ * * Provides access to the CPU machine-specific registers. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/ohci.h b/system/ohci.h index f9b4e70..45821e0 100644 --- a/system/ohci.h +++ b/system/ohci.h @@ -6,6 +6,7 @@ * * Provides support for USB keyboards connected via an OHCI controller. * + *//* * Copyright (C) 2021-2022 Martin Whitaker. */ diff --git a/system/pci.h b/system/pci.h index bbe7b11..3db4ad1 100644 --- a/system/pci.h +++ b/system/pci.h @@ -6,6 +6,7 @@ * * Provides functions to perform PCI configuration space reads and writes. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/pmem.h b/system/pmem.h index 0f7b649..ec130c6 100644 --- a/system/pmem.h +++ b/system/pmem.h @@ -6,6 +6,7 @@ * * Provides a description of the system physical memory map. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/screen.h b/system/screen.h index 27e7d2d..2719b39 100644 --- a/system/screen.h +++ b/system/screen.h @@ -7,6 +7,7 @@ * Provides the display interface. It provides an 80x25 VGA-compatible text * display. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/smp.h b/system/smp.h index 65ab41c..f18bc17 100644 --- a/system/smp.h +++ b/system/smp.h @@ -6,6 +6,7 @@ * * Provides support for multi-threaded operation. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/temperature.h b/system/temperature.h index d30c8a4..73fdcef 100644 --- a/system/temperature.h +++ b/system/temperature.h @@ -6,6 +6,7 @@ * * Provides a function to read the CPU core temperature. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/tsc.h b/system/tsc.h index 09098f5..ce7e489 100644 --- a/system/tsc.h +++ b/system/tsc.h @@ -6,6 +6,7 @@ * * Provides access to the CPU timestamp counter. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/uhci.h b/system/uhci.h index 5727b36..72a4a26 100644 --- a/system/uhci.h +++ b/system/uhci.h @@ -6,6 +6,7 @@ * * Provides support for USB keyboards connected via an UHCI controller. * + *//* * Copyright (C) 2021-2022 Martin Whitaker. */ diff --git a/system/usb.h b/system/usb.h index 52b4df4..b8ca3db 100644 --- a/system/usb.h +++ b/system/usb.h @@ -7,6 +7,7 @@ * Provides definitions of various values and data structures defined by the * USB specifications. * + *//* * Copyright (C) 2021-2022 Martin Whitaker. */ diff --git a/system/usbhcd.h b/system/usbhcd.h index 5b8d9df..475705c 100644 --- a/system/usbhcd.h +++ b/system/usbhcd.h @@ -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. */ diff --git a/system/vmem.h b/system/vmem.h index 90baf1c..4cb43bf 100644 --- a/system/vmem.h +++ b/system/vmem.h @@ -7,6 +7,7 @@ * Provides functions to handle physical memory page mapping into virtual * memory. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/system/xhci.h b/system/xhci.h index 3468def..e713906 100644 --- a/system/xhci.h +++ b/system/xhci.h @@ -6,6 +6,7 @@ * * Provides support for USB keyboards connected via an XHCI controller. * + *//* * Copyright (C) 2021-2022 Martin Whitaker. */ diff --git a/tests/test_funcs.h b/tests/test_funcs.h index 6e6a2ff..45191de 100644 --- a/tests/test_funcs.h +++ b/tests/test_funcs.h @@ -7,6 +7,7 @@ * Provides the prototypes for the basic test functions used to implement * the tests. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/tests/test_helper.h b/tests/test_helper.h index 66484e2..7d6772c 100644 --- a/tests/test_helper.h +++ b/tests/test_helper.h @@ -7,6 +7,7 @@ * Provides some common definitions and helper functions for the memory * tests. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */ diff --git a/tests/tests.h b/tests/tests.h index 5f55038..cc1e1c9 100644 --- a/tests/tests.h +++ b/tests/tests.h @@ -6,6 +6,7 @@ * * Provides support for identifying and running the memory tests. * + *//* * Copyright (C) 2020-2022 Martin Whitaker. */