Tag all source files with @file for doxygen

pull/129/head
D.R.racer 2021-10-18 16:27:31 +02:00 committed by DRracer
parent 5b9c6ec36e
commit 0fbcb9dac2
92 changed files with 92 additions and 0 deletions

View File

@ -1,3 +1,4 @@
/// @file cmath.h
// Provide an uniform interface for basic math functions between AVR libc and newer
// standards that support <cmath>
#pragma once

View File

@ -1,3 +1,4 @@
/// @file axis.h
#pragma once
#include <stdint.h>
#include "../unit.h"

View File

@ -1,3 +1,4 @@
/// @file config.h
#pragma once
#include <stdint.h>
#include "axis.h"

View File

@ -1,3 +1,4 @@
/// @file debug.cpp
#include "debug.h"
#if defined(DEBUG_LOGIC) || defined(DEBUG_MODULES) || defined(DEBUG_HAL)

View File

@ -1,3 +1,4 @@
/// @file debug.h
#pragma once
#include <stdint.h>
#include "config/config.h"

View File

@ -1,3 +1,4 @@
/// @file adc.cpp
#include "adc.h"
#include <avr/io.h>

View File

@ -1,3 +1,4 @@
/// @file adc.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file cpu.cpp
#include "../cpu.h"
#include <avr/interrupt.h>
#include "../watchdog.h"

View File

@ -1,3 +1,4 @@
/// @file eeprom.cpp
#include "../eeprom.h"
#include <avr/eeprom.h>

View File

@ -1,3 +1,4 @@
/// @file shr16.cpp
#include "../shr16.h"
#include "../gpio.h"
#include "../../pins.h"

View File

@ -1,3 +1,4 @@
/// @file spi.cpp
#include "../spi.h"
namespace hal {

View File

@ -1,3 +1,4 @@
/// @file timers.cpp
#include "../timers.h"
namespace hal {

View File

@ -1,3 +1,4 @@
/// @file usart.cpp
#include "../usart.h"
#include <avr/interrupt.h>
#include <avr/pgmspace.h>

View File

@ -1,3 +1,4 @@
/// @file watchdog.cpp
#include "../watchdog.h"
#include <avr/wdt.h>

View File

@ -1,3 +1,4 @@
/// @file circular_buffer.h
#pragma once
#include <stddef.h>
#include "../intlimits.h"

View File

@ -1,3 +1,4 @@
/// @file cpu.h
#pragma once
namespace hal {

View File

@ -1,3 +1,4 @@
/// @file eeprom.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file gpio.h
#pragma once
#include <inttypes.h>

View File

@ -1,3 +1,4 @@
/// @file progmem.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file shr16.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file spi.h
#pragma once
#include <inttypes.h>
#include "gpio.h"

View File

@ -1,3 +1,4 @@
/// @file timers.h
#pragma once
#include <avr/io.h>

View File

@ -1,3 +1,4 @@
/// @file tmc2130.cpp
#include "tmc2130.h"
#include "../config/config.h"

View File

@ -1,3 +1,4 @@
/// @file tmc2130.h
#pragma once
#include "../config/config.h"
#include "../hal/gpio.h"

View File

@ -1,3 +1,4 @@
/// @file usart.h
#pragma once
#include <inttypes.h>
#include <avr/io.h>

View File

@ -1,3 +1,4 @@
/// @file watchdog.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file intlimits.h
#pragma once
#ifndef __AVR__
#include <limits>

View File

@ -1,3 +1,4 @@
/// @file command_base.cpp
#include "command_base.h"
#include "../modules/idler.h"
#include "../modules/selector.h"

View File

@ -1,3 +1,4 @@
/// @file command_base.h
#pragma once
#include <stdint.h>
#include "error_codes.h"

View File

@ -1,3 +1,4 @@
/// @file cut_filament.cpp
#include "cut_filament.h"
#include "../modules/buttons.h"
#include "../modules/finda.h"

View File

@ -1,3 +1,4 @@
/// @file cut_filament.h
#pragma once
#include <stdint.h>
#include "command_base.h"

View File

@ -1,3 +1,4 @@
/// @file eject_filament.cpp
#include "eject_filament.h"
#include "../modules/buttons.h"
#include "../modules/finda.h"

View File

@ -1,3 +1,4 @@
/// @file eject_filament.h
#pragma once
#include <stdint.h>
#include "command_base.h"

View File

@ -1,3 +1,4 @@
/// @file feed_to_bondtech.cpp
#include "feed_to_bondtech.h"
#include "../modules/buttons.h"
#include "../modules/fsensor.h"

View File

@ -1,3 +1,4 @@
/// @file feed_to_bondtech.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file feed_to_finda.cpp
#include "feed_to_finda.h"
#include "../modules/finda.h"
#include "../modules/globals.h"

View File

@ -1,3 +1,4 @@
/// @file feed_to_finda.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file load_filament.cpp
#include "load_filament.h"
#include "../modules/finda.h"
#include "../modules/globals.h"

View File

@ -1,3 +1,4 @@
/// @file load_filament.h
#pragma once
#include <stdint.h>
#include "command_base.h"

View File

@ -1,3 +1,4 @@
/// @file no_command.cpp
#include "no_command.h"
namespace logic {

View File

@ -1,3 +1,4 @@
/// @file no_command.h
#pragma once
#include <stdint.h>
#include "command_base.h"

View File

@ -1,3 +1,4 @@
/// @file retract_from_finda.cpp
#include "retract_from_finda.h"
#include "../modules/finda.h"
#include "../modules/globals.h"

View File

@ -1,3 +1,4 @@
/// @file retract_from_finda.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file set_mode.cpp
#include "set_mode.h"
#include "../modules/globals.h"
#include "../modules/motion.h"

View File

@ -1,3 +1,4 @@
/// @file set_mode.h
#pragma once
#include <stdint.h>
#include "command_base.h"

View File

@ -1,3 +1,4 @@
/// @file tool_change.cpp
#include "tool_change.h"
#include "../modules/buttons.h"
#include "../modules/finda.h"

View File

@ -1,3 +1,4 @@
/// @file tool_change.h
#pragma once
#include <stdint.h>
#include "command_base.h"

View File

@ -1,3 +1,4 @@
/// @file unload_filament.cpp
#include "unload_filament.h"
#include "../modules/finda.h"
#include "../modules/globals.h"

View File

@ -1,3 +1,4 @@
/// @file unload_filament.h
#pragma once
#include <stdint.h>
#include "command_base.h"

View File

@ -1,3 +1,4 @@
/// @file unload_to_finda.cpp
#include "unload_to_finda.h"
#include "../modules/finda.h"
#include "../modules/globals.h"

View File

@ -1,3 +1,4 @@
/// @file unload_to_finda.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file axisunit.h
#pragma once
#include "../config/axis.h"
#include "pulse_gen.h"

View File

@ -1,3 +1,4 @@
/// @file buttons.cpp
#include "buttons.h"
#include "../hal/adc.h"
#include "timebase.h"

View File

@ -1,3 +1,4 @@
/// @file buttons.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file debouncer.cpp
#include "debouncer.h"
namespace modules {

View File

@ -1,3 +1,4 @@
/// @file debouncer.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file finda.cpp
#include "finda.h"
#include "timebase.h"
#include "../hal/gpio.h"

View File

@ -1,3 +1,4 @@
/// @file finda.h
#pragma once
#include <stdint.h>
#include "debouncer.h"

View File

@ -1,3 +1,4 @@
/// @file fsensor.cpp
#include "fsensor.h"
#include "timebase.h"

View File

@ -1,3 +1,4 @@
/// @file fsensor.h
#pragma once
#include <stdint.h>
#include "debouncer.h"

View File

@ -1,3 +1,4 @@
/// @file globals.cpp
#include "globals.h"
#include "permanent_storage.h"

View File

@ -1,3 +1,4 @@
/// @file globals.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file idler.cpp
#include "idler.h"
#include "buttons.h"
#include "leds.h"

View File

@ -1,3 +1,4 @@
/// @file idler.h
#pragma once
#include "../config/config.h"
#include "axisunit.h"

View File

@ -1,3 +1,4 @@
/// @file leds.cpp
#include "leds.h"
#include "../hal/shr16.h"
#include "timebase.h"

View File

@ -1,3 +1,4 @@
/// @file leds.h
#pragma once
#include "../config/config.h"
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file math.h
#pragma once
#include "../config/config.h"

View File

@ -1,3 +1,4 @@
/// @file motion.cpp
#include "motion.h"
#include "../panic.h"
#include "../debug.h"

View File

@ -1,3 +1,4 @@
/// @file motion.h
#pragma once
#include "../pins.h"
#include "pulse_gen.h"

View File

@ -1,3 +1,4 @@
/// @file movable_base.cpp
#include "movable_base.h"
#include "globals.h"
#include "motion.h"

View File

@ -1,3 +1,4 @@
/// @file movable_base.h
#pragma once
#include <stdint.h>
#include "../config/axis.h"

View File

@ -1,3 +1,4 @@
/// @file permanent_storage.cpp
#include "permanent_storage.h"
#include "../hal/eeprom.h"
#include "globals.h"

View File

@ -1,3 +1,4 @@
/// @file permanent_storage.h
#pragma once
#include "../hal/eeprom.h"

View File

@ -1,3 +1,4 @@
/// @file protocol.cpp
#include "protocol.h"
// protocol definition

View File

@ -1,3 +1,4 @@
/// @file protocol.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file pulse_gen.cpp
#include "pulse_gen.h"
namespace modules {

View File

@ -1,3 +1,4 @@
/// @file pulse_gen.h
#pragma once
#include "speed_table.h"
#include "../hal/tmc2130.h"

View File

@ -1,3 +1,4 @@
/// @file selector.cpp
#include "selector.h"
#include "buttons.h"
#include "leds.h"

View File

@ -1,3 +1,4 @@
/// @file selector.h
#pragma once
#include "../config/config.h"
#include "axisunit.h"

View File

@ -1,3 +1,4 @@
/// @file speed_table.cpp
#include "speed_table.h"
namespace modules {

View File

@ -1,3 +1,4 @@
/// @file speed_table.h
#pragma once
#include "../config/config.h"
#include "../hal/progmem.h"

View File

@ -1,3 +1,4 @@
/// @file timebase.cpp
#include "timebase.h"
#include "../hal/timers.h"
#include <avr/interrupt.h>

View File

@ -1,3 +1,4 @@
/// @file timebase.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file usb_cdc.cpp
#include "usb_cdc.h"
#include "../hal/cpu.h"
#include "../hal/watchdog.h"

View File

@ -1,3 +1,4 @@
/// @file usb_cdc.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file user_input.cpp
#include "user_input.h"
#include "buttons.h"

View File

@ -1,3 +1,4 @@
/// @file user_input.h
#pragma once
#include <stdint.h>
#include "../hal/circular_buffer.h"

View File

@ -1,3 +1,4 @@
/// @file panic.h
#pragma once
#include <stdint.h>
#include "logic/error_codes.h"

View File

@ -1,3 +1,4 @@
/// @file pins.h
#pragma once
#include "hal/gpio.h"

View File

@ -1,3 +1,4 @@
/// @file unit.h
#pragma once
#include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file version.c
#include "version.h"
#define _STR(x) #x

View File

@ -1,3 +1,4 @@
/// @file version.h
#pragma once
#ifdef __cplusplus