From 6d4060d824603db4d86fd1f414a247a133f886b7 Mon Sep 17 00:00:00 2001 From: David Holdeman Date: Sat, 22 May 2021 14:10:58 -0500 Subject: [PATCH] Doxygen titles (#2728) * move addRow call * undo submo bump * add header titles --- firmware/bootloader/readme.md | 2 ++ firmware/config/boards/hellen/cypress/readme.md | 2 ++ firmware/config/boards/hellen/hellen72/readme.md | 4 ---- firmware/config/boards/kinetis/OS/os/readme.md | 4 +++- firmware/config/boards/kinetis/libc/readme.md | 3 ++- firmware/config/boards/kinetis/readme.md | 2 ++ firmware/config/boards/microrusefi/readme.md | 3 ++- firmware/config/boards/prometheus/readme.md | 2 ++ firmware/config/boards/proteus/readme.md | 3 ++- firmware/config/boards/readme.md | 4 +++- firmware/config/boards/skeleton/readme.md | 2 ++ firmware/config/engines/readme.md | 2 ++ firmware/controllers/engine_cycle/readme.md | 4 +++- firmware/controllers/gauges/readme.md | 4 +++- firmware/controllers/generated/readme.md | 2 ++ firmware/controllers/system/timer/readme.md | 3 ++- firmware/controllers/trigger/decoders/readme.md | 4 +++- firmware/ext_algo/readme.md | 3 ++- firmware/hw_layer/mc33816/rusefi/readme.md | 3 ++- firmware/hw_layer/readme.md | 1 + firmware/tunerstudio/docs/readme.MD | 3 ++- firmware/tunerstudio/readme.md | 4 +++- firmware/tunerstudio/translations/readme.md | 3 ++- firmware/util/readme.md | 3 ++- 24 files changed, 51 insertions(+), 19 deletions(-) delete mode 100644 firmware/config/boards/hellen/hellen72/readme.md diff --git a/firmware/bootloader/readme.md b/firmware/bootloader/readme.md index 80d17d26c9..7de3ba3a97 100644 --- a/firmware/bootloader/readme.md +++ b/firmware/bootloader/readme.md @@ -1,3 +1,5 @@ +# Bootloader + *** User Manual *** To start the bootloader updater: diff --git a/firmware/config/boards/hellen/cypress/readme.md b/firmware/config/boards/hellen/cypress/readme.md index 2cc30e6b05..00a05e8209 100644 --- a/firmware/config/boards/hellen/cypress/readme.md +++ b/firmware/config/boards/hellen/cypress/readme.md @@ -1,3 +1,5 @@ +# Cypress + rusEFI runs on Cypress FM4 S6E2xx (alpha version as of Jan 2020) Most tested on S6E2CxAH - S6E2C5AH0AGV2000A (144-pin) to be exact. diff --git a/firmware/config/boards/hellen/hellen72/readme.md b/firmware/config/boards/hellen/hellen72/readme.md deleted file mode 100644 index 1f5f8711a7..0000000000 --- a/firmware/config/boards/hellen/hellen72/readme.md +++ /dev/null @@ -1,4 +0,0 @@ - -https://rusefi.com/forum/viewtopic.php?f=4&t=1538 - -https://github.com/rusefi/hw_microRusEfi \ No newline at end of file diff --git a/firmware/config/boards/kinetis/OS/os/readme.md b/firmware/config/boards/kinetis/OS/os/readme.md index 88386ccc74..a41e1d23a3 100644 --- a/firmware/config/boards/kinetis/OS/os/readme.md +++ b/firmware/config/boards/kinetis/OS/os/readme.md @@ -1,3 +1,5 @@ +# Kinetis OS + Standard NXP headers firmware/config/boards/kinetis/OS/os/common/ext/CMSIS/KINETIS @@ -17,4 +19,4 @@ flash1a & flash1b is some hardware configuration magic firmware/config/boards/kinetis/OS/os/hal/ports/KINETIS/KE1xF/fsl contains Kinetis SDK files with modifications: 1) include hal.h in the beginning - 2) firmware/config/boards/kinetis/OS/os/hal/ports/KINETIS/KE1xF/fsl/fsl_lpuart.c has UART patch (see AndreiKA tag) \ No newline at end of file + 2) firmware/config/boards/kinetis/OS/os/hal/ports/KINETIS/KE1xF/fsl/fsl_lpuart.c has UART patch (see AndreiKA tag) diff --git a/firmware/config/boards/kinetis/libc/readme.md b/firmware/config/boards/kinetis/libc/readme.md index b91a72729e..8e05b8f2c5 100644 --- a/firmware/config/boards/kinetis/libc/readme.md +++ b/firmware/config/boards/kinetis/libc/readme.md @@ -1,3 +1,4 @@ +# Kinetis libC Here is the magic here 1) AndreiKA has downloaded libtinyc from somewhere @@ -9,4 +10,4 @@ libtinyc.a is the gcc library produced from all the above mentioned object files todo: open question where is the official home of libtinyc -This is about wasting as little RAM as possible. Even complete libtinyc wastes some RAM. \ No newline at end of file +This is about wasting as little RAM as possible. Even complete libtinyc wastes some RAM. diff --git a/firmware/config/boards/kinetis/readme.md b/firmware/config/boards/kinetis/readme.md index 8e955087a8..2d27ba47bd 100644 --- a/firmware/config/boards/kinetis/readme.md +++ b/firmware/config/boards/kinetis/readme.md @@ -1,3 +1,5 @@ +# Kinetis + rusEfi runs on MKE16F512 (alpha version as of July 2019) rusEfi Kinetis implementation consists of three files/folders: diff --git a/firmware/config/boards/microrusefi/readme.md b/firmware/config/boards/microrusefi/readme.md index 1f5f8711a7..0b9b0f87b6 100644 --- a/firmware/config/boards/microrusefi/readme.md +++ b/firmware/config/boards/microrusefi/readme.md @@ -1,4 +1,5 @@ +# MicroRusEFI https://rusefi.com/forum/viewtopic.php?f=4&t=1538 -https://github.com/rusefi/hw_microRusEfi \ No newline at end of file +https://github.com/rusefi/hw_microRusEfi diff --git a/firmware/config/boards/prometheus/readme.md b/firmware/config/boards/prometheus/readme.md index 4807635ff4..ed125b983d 100644 --- a/firmware/config/boards/prometheus/readme.md +++ b/firmware/config/boards/prometheus/readme.md @@ -1,3 +1,5 @@ +# Prometheus + Prometheus board. http://rusefi.com/forum/viewtopic.php?f=4&t=1215 diff --git a/firmware/config/boards/proteus/readme.md b/firmware/config/boards/proteus/readme.md index 589ceb8668..6d6fe3a250 100644 --- a/firmware/config/boards/proteus/readme.md +++ b/firmware/config/boards/proteus/readme.md @@ -1,4 +1,5 @@ +# Proteus https://rusefi.com/forum/viewtopic.php?f=4&t=1646 -https://github.com/mck1117/proteus \ No newline at end of file +https://github.com/mck1117/proteus diff --git a/firmware/config/boards/readme.md b/firmware/config/boards/readme.md index c7022c511e..89c9ab5493 100644 --- a/firmware/config/boards/readme.md +++ b/firmware/config/boards/readme.md @@ -1,3 +1,5 @@ +# Boards Directory + See [misc/jenkins/compile_other_versions/run.bat](misc/jenkins/compile_other_versions/run.bat) which is executed by build server. @@ -7,4 +9,4 @@ By definition, BOARD_NAME is a folder in firmware\config\boards One BOARD_NAME could be producing a number of artifacts via compile_$BUNDLE_NAME.sh scripts -Work in progress: SHORT_BOARDNAME becomes BUNDLE_NAME \ No newline at end of file +Work in progress: SHORT_BOARDNAME becomes BUNDLE_NAME diff --git a/firmware/config/boards/skeleton/readme.md b/firmware/config/boards/skeleton/readme.md index 0f09732e09..d1a7363f15 100644 --- a/firmware/config/boards/skeleton/readme.md +++ b/firmware/config/boards/skeleton/readme.md @@ -1,3 +1,5 @@ +# Skeleton Board + This directory contains an example of the files needed to configure the firmware for a specific RusEFI board. diff --git a/firmware/config/engines/readme.md b/firmware/config/engines/readme.md index 87d316d5ba..fd6474c2b4 100644 --- a/firmware/config/engines/readme.md +++ b/firmware/config/engines/readme.md @@ -1,3 +1,5 @@ +# Engine Configs + This directory contains pre-defined configurations for popular engines. These configurations are a convenience, not a limit. Most engine types diff --git a/firmware/controllers/engine_cycle/readme.md b/firmware/controllers/engine_cycle/readme.md index 111595326d..ac2eed055f 100644 --- a/firmware/controllers/engine_cycle/readme.md +++ b/firmware/controllers/engine_cycle/readme.md @@ -1 +1,3 @@ -Here we have logic related to engine contol activitied within each engine cycle: coils & injectors mostly. \ No newline at end of file +# Engine Cycle + +Here we have logic related to engine contol activitied within each engine cycle: coils & injectors mostly. diff --git a/firmware/controllers/gauges/readme.md b/firmware/controllers/gauges/readme.md index e4952d8b09..e9b27c1987 100644 --- a/firmware/controllers/gauges/readme.md +++ b/firmware/controllers/gauges/readme.md @@ -1 +1,3 @@ -This folder has code related to communication with the human behind the steering wheel: tachometer, check engine light, LCD etc etc. \ No newline at end of file +# Gauges + +This folder has code related to communication with the human behind the steering wheel: tachometer, check engine light, LCD etc etc. diff --git a/firmware/controllers/generated/readme.md b/firmware/controllers/generated/readme.md index c754e5d81a..0ecf0f9793 100644 --- a/firmware/controllers/generated/readme.md +++ b/firmware/controllers/generated/readme.md @@ -1,3 +1,5 @@ +# Generated Code + All the code here was generated by tools. See gen_config.bat diff --git a/firmware/controllers/system/timer/readme.md b/firmware/controllers/system/timer/readme.md index 6a21cb6bbc..809b2309f0 100644 --- a/firmware/controllers/system/timer/readme.md +++ b/firmware/controllers/system/timer/readme.md @@ -1 +1,2 @@ -In this folder we have files related to hubrid hardware/software timer, including PWM generation. \ No newline at end of file +# Timer +In this folder we have files related to hubrid hardware/software timer, including PWM generation. diff --git a/firmware/controllers/trigger/decoders/readme.md b/firmware/controllers/trigger/decoders/readme.md index baacf1220c..ff5090e869 100644 --- a/firmware/controllers/trigger/decoders/readme.md +++ b/firmware/controllers/trigger/decoders/readme.md @@ -1 +1,3 @@ -This folder is and should not be aware of engine.h or engine_configuration.h \ No newline at end of file +# Trigger Decoders + +This folder is and should not be aware of engine.h or engine_configuration.h diff --git a/firmware/ext_algo/readme.md b/firmware/ext_algo/readme.md index fa761829a5..37e6037ba7 100644 --- a/firmware/ext_algo/readme.md +++ b/firmware/ext_algo/readme.md @@ -1 +1,2 @@ -In this folder we have 3rd party code \ No newline at end of file +# Ext Algo +In this folder we have 3rd party code diff --git a/firmware/hw_layer/mc33816/rusefi/readme.md b/firmware/hw_layer/mc33816/rusefi/readme.md index 7459e997d6..eb7e189c67 100644 --- a/firmware/hw_layer/mc33816/rusefi/readme.md +++ b/firmware/hw_layer/mc33816/rusefi/readme.md @@ -1 +1,2 @@ -Completely default project as generated by MC33816 Dev Studio conveniently comes with default source code. \ No newline at end of file +# MC33816 Default Project +Completely default project as generated by MC33816 Dev Studio conveniently comes with default source code. diff --git a/firmware/hw_layer/readme.md b/firmware/hw_layer/readme.md index dc96791811..7d4cb808f7 100644 --- a/firmware/hw_layer/readme.md +++ b/firmware/hw_layer/readme.md @@ -1 +1,2 @@ +# Hardware Layer https://github.com/rusefi/rusefi/wiki/ASIC diff --git a/firmware/tunerstudio/docs/readme.MD b/firmware/tunerstudio/docs/readme.MD index bdf5f18ba8..61f8c48a63 100644 --- a/firmware/tunerstudio/docs/readme.MD +++ b/firmware/tunerstudio/docs/readme.MD @@ -1,5 +1,6 @@ +# TunerStudio Docs Tuner Studio dialogs as of May 2017 ![TS](0-1_Engine_Menu_1-25.png) -![TS](0 - 2 Tuning menu (2-47).png) \ No newline at end of file +![TS](0 - 2 Tuning menu (2-47).png) diff --git a/firmware/tunerstudio/readme.md b/firmware/tunerstudio/readme.md index a0b5be09e3..ed6123106c 100644 --- a/firmware/tunerstudio/readme.md +++ b/firmware/tunerstudio/readme.md @@ -1,3 +1,5 @@ +# TunerStudio + This directory contains the initialization and configuration files for the RusEFI interface to TunerStudio. @@ -26,4 +28,4 @@ On Windows this may be run with ```gen_config.bat```. Q: how do I offer my changes to TS project? -A: please PR only rusefi.input. Once merged, gen_config.bat would be executed automatically and results would be pushed by automation. \ No newline at end of file +A: please PR only rusefi.input. Once merged, gen_config.bat would be executed automatically and results would be pushed by automation. diff --git a/firmware/tunerstudio/translations/readme.md b/firmware/tunerstudio/translations/readme.md index 02cff4e754..eb708a7f95 100644 --- a/firmware/tunerstudio/translations/readme.md +++ b/firmware/tunerstudio/translations/readme.md @@ -1,3 +1,4 @@ +# TunerStudio Translations To install translations copy the content of this folder to EFIAnalytics\TunerStudioMS\content\ -For example C:\Program Files (x86)\EFIAnalytics\TunerStudioMS\content\ \ No newline at end of file +For example C:\Program Files (x86)\EFIAnalytics\TunerStudioMS\content\ diff --git a/firmware/util/readme.md b/firmware/util/readme.md index db9039bbef..55bf96e097 100644 --- a/firmware/util/readme.md +++ b/firmware/util/readme.md @@ -1,3 +1,4 @@ +# Util In this folder we have all the tiny utility stuff. -Ideally, code from this folder should not depend on code from any other folder. \ No newline at end of file +Ideally, code from this folder should not depend on code from any other folder.