Skip to content

Re-align all Doxygen tags. #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xchrishawk merged 1 commit into from
Aug 29, 2025
Merged

Re-align all Doxygen tags. #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#
# @file .gitignore
# @brief Main project gitignore.
# @file .gitignore
# @brief Main project gitignore.
#
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
#

# Ignore .vscode directory, except for c_cpp_properties.json since it's required for intellisense
Expand Down
10 changes: 5 additions & 5 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#
# @file CMakeLists.txt
# @brief Main project CMake configuration.
# @file CMakeLists.txt
# @brief Main project CMake configuration.
#
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
#

cmake_minimum_required(VERSION 3.22)
Expand Down
13 changes: 7 additions & 6 deletions Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#
# @file Doxyfile
# @brief Doxyfile for generating Doxygen documentation.
# @file Doxyfile
# @brief Doxyfile for generating Doxygen documentation.
#
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-25
# @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-25
# @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
#
# NOTE:
# CMake processes Doxyfile.in in the root directory, and saves it to build/Doxyfile, which is then used to generate the
Expand All @@ -23,4 +23,5 @@ GENERATE_LATEX = NO
GENERATE_HTML = YES
EXCLUDE_SYMBOLS = _Static_assert ISR
USE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/readme.md
MARKDOWN_SUPPORT = YES
MARKDOWN_SUPPORT = YES
ALIASES += cpyrt=\copyright
10 changes: 5 additions & 5 deletions configuration.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#
# @file configuration.cmake
# @brief CMake file defining the project's configuration options.
# @file configuration.cmake
# @brief CMake file defining the project's configuration options.
#
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-19
# @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-19
# @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
#

# -- Configuration Defaults --
Expand Down
10 changes: 5 additions & 5 deletions src/executable.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#
# @file executable.cmake
# @brief Template CMake file for executable images.
# @file executable.cmake
# @brief Template CMake file for executable images.
#
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
#
# Skeleton CMake file which can be included in a CMakeLists.txt file to set up an executable.
# This allows quickly creating new executables with a minimum amount of boilerplate.
Expand Down
10 changes: 5 additions & 5 deletions src/main/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#
# @file CMakeLists.txt
# @brief CMake configuration for the main project executable.
# @file CMakeLists.txt
# @brief CMake configuration for the main project executable.
#
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
# @author Chris Vig (chris@invictus.so)
# @date 2025-08-16
# @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
#

# -- Executable Configuration --
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/buzzer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/buzzer.c
* @brief Implementation for the buzzer driver module.
* @file src/main/application/buzzer.c
* @brief Implementation for the buzzer driver module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/buzzer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/buzzer.h
* @brief Header for the buzzer driver module.
* @file src/main/application/buzzer.h
* @brief Header for the buzzer driver module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_BUZZER_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/config.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/config.c
* @brief Implementation for the application configuration module.
* @file src/main/application/config.c
* @brief Implementation for the application configuration module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/config.h
* @brief Header for the application configuration module.
* @file src/main/application/config.h
* @brief Header for the application configuration module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_CONFIG_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/debug_port.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/debug_port.c
* @brief Implementation for the debug port module.
* @file src/main/application/debug_port.c
* @brief Implementation for the debug port module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/debug_port.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/debug_port.h
* @brief Header for the debug port module.
* @file src/main/application/debug_port.h
* @brief Header for the debug port module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-20
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_DEBUG_PORT_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/input.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/input.c
* @brief Implementation for the key input module.
* @file src/main/application/input.c
* @brief Implementation for the key input module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/input.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/input.h
* @brief Header for the key input module.
* @file src/main/application/input.h
* @brief Header for the key input module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_INPUT_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/keyer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/keyer.c
* @brief Implementation for the keyer module.
* @file src/main/application/keyer.c
* @brief Implementation for the keyer module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-19
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-19
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/keyer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/keyer.h
* @brief Header for the keyer module.
* @file src/main/application/keyer.h
* @brief Header for the keyer module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-19
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-19
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_KEYER_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/led.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/led.c
* @brief Implementation for the LED driver module.
* @file src/main/application/led.c
* @brief Implementation for the LED driver module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/led.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/led.h
* @brief Header for the LED driver module.
* @file src/main/application/led.h
* @brief Header for the LED driver module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-17
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_LED_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/storage.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/storage.c
* @brief Implementation for the application-specific storage module.
* @file src/main/application/storage.c
* @brief Implementation for the application-specific storage module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-26
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-26
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/storage.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/storage.h
* @brief Header for the application-specific storage module.
* @file src/main/application/storage.h
* @brief Header for the application-specific storage module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-26
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-26
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_STORAGE_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/strings.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/strings.c
* @brief Implementation for the strings module.
* @file src/main/application/strings.c
* @brief Implementation for the strings module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-28
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-28
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/strings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/strings.h
* @brief Header for the strings module.
* @file src/main/application/strings.h
* @brief Header for the strings module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-28
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-28
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_STRINGS_H )
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/wpm.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/wpm.c
* @brief Implementation for the Morse code utility module.
* @file src/main/application/wpm.c
* @brief Implementation for the Morse code utility module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-22
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-22
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

/* ---------------------------------------------------- INCLUDES ---------------------------------------------------- */
Expand Down
10 changes: 5 additions & 5 deletions src/main/application/wpm.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* @file src/main/application/wpm.h
* @brief Header for the Morse code utility module.
* @file src/main/application/wpm.h
* @brief Header for the Morse code utility module.
*
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-22
* @copyright © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
* @author Chris Vig (chris@invictus.so)
* @date 2025-08-22
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
*/

#if !defined( APPLICATION_WPM_H )
Expand Down
Loading