Skip to content

Fix Doxygen Header #215

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
gabryelreyes merged 3 commits into from
Jan 2, 2026
Merged

Fix Doxygen Header #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12efb3c
Updated copyright year
gabryelreyes Jan 2, 2026
8d0744a
Added Doxygen file command
gabryelreyes Jan 2, 2026
550fbbe
Fixed new Doxygen findings
gabryelreyes Jan 2, 2026
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
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 - 2025 Andreas Merkle
Copyright (c) 2023 - 2026 Andreas Merkle

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/ConvoyFollowerSimDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/ConvoyFollowerTargetDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/ConvoyLeaderSimDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/ConvoyLeaderTargetDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2533,7 +2533,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/LineFollowerSimDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/LineFollowerTargetDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/RemoteControlSimDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/RemoteControlTargetDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/SensorFusionSimDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/SensorFusionTargetDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/TurtleSimDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
3 changes: 2 additions & 1 deletion doc/doxygen/TurtleTargetDoxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2532,7 +2532,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __attribute__(x)=
PREDEFINED = __attribute__(x)= \
IRAM_ATTR

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
4 changes: 3 additions & 1 deletion lib/APPConvoyFollower/src/App.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief ConvoyFollower application
* @author Andreas Merkle <web@blue-andi.de>
*/
Expand Down Expand Up @@ -53,6 +54,7 @@
* Macros
*****************************************************************************/

/** Configuration of the logging severity if not previously defined. */
#ifndef CONFIG_LOG_SEVERITY
#define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO)
#endif /* CONFIG_LOG_SEVERITY */
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/App.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief ConvoyFollower application
* @author Andreas Merkle <web@blue-andi.de>
*
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/DrivingState.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Driving state.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*/
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/DrivingState.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Driving state.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/ErrorState.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Error State.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*/
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/ErrorState.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Error State.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/SerialMuxChannels.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Channel structure definition for the SerialMuxProt.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/StartupState.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Startup State.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*/
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyFollower/src/StartupState.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Startup State.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*
Expand Down
4 changes: 3 additions & 1 deletion lib/APPConvoyLeader/src/App.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief ConvoyLeader application
* @author Andreas Merkle <web@blue-andi.de>
*/
Expand Down Expand Up @@ -53,6 +54,7 @@
* Macros
*****************************************************************************/

/** Configuration of the logging severity if not previously defined. */
#ifndef CONFIG_LOG_SEVERITY
#define CONFIG_LOG_SEVERITY (Logging::LOG_LEVEL_INFO)
#endif /* CONFIG_LOG_SEVERITY */
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyLeader/src/App.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief ConvoyLeader application
* @author Andreas Merkle <web@blue-andi.de>
*
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyLeader/src/DrivingState.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Driving state.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*/
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyLeader/src/DrivingState.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Driving state.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyLeader/src/ErrorState.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Error State.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*/
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyLeader/src/ErrorState.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Error State.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*
Expand Down
3 changes: 2 additions & 1 deletion lib/APPConvoyLeader/src/SerialMuxChannels.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* MIT License
*
* Copyright (c) 2023 - 2025 Andreas Merkle <web@blue-andi.de>
* Copyright (c) 2023 - 2026 Andreas Merkle <web@blue-andi.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,6 +25,7 @@
DESCRIPTION
*******************************************************************************/
/**
* @file
* @brief Channel structure definition for the SerialMuxProt.
* @author Gabryel Reyes <gabryelrdiaz@gmail.com>
*
Expand Down
Loading