Doxygen titles (#2728)

* move addRow call

* undo submo bump

* add header titles
This commit is contained in:
David Holdeman 2021-05-22 14:10:58 -05:00 committed by GitHub
parent e5ed714404
commit 6d4060d824
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 51 additions and 19 deletions

View File

@ -1,3 +1,5 @@
# Bootloader
*** User Manual ***
To start the bootloader updater:

View File

@ -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.

View File

@ -1,4 +0,0 @@
https://rusefi.com/forum/viewtopic.php?f=4&t=1538
https://github.com/rusefi/hw_microRusEfi

View File

@ -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)
2) firmware/config/boards/kinetis/OS/os/hal/ports/KINETIS/KE1xF/fsl/fsl_lpuart.c has UART patch (see AndreiKA tag)

View File

@ -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.
This is about wasting as little RAM as possible. Even complete libtinyc wastes some RAM.

View File

@ -1,3 +1,5 @@
# Kinetis
rusEfi runs on MKE16F512 (alpha version as of July 2019)
rusEfi Kinetis implementation consists of three files/folders:

View File

@ -1,4 +1,5 @@
# MicroRusEFI
https://rusefi.com/forum/viewtopic.php?f=4&t=1538
https://github.com/rusefi/hw_microRusEfi
https://github.com/rusefi/hw_microRusEfi

View File

@ -1,3 +1,5 @@
# Prometheus
Prometheus board.
http://rusefi.com/forum/viewtopic.php?f=4&t=1215

View File

@ -1,4 +1,5 @@
# Proteus
https://rusefi.com/forum/viewtopic.php?f=4&t=1646
https://github.com/mck1117/proteus
https://github.com/mck1117/proteus

View File

@ -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
Work in progress: SHORT_BOARDNAME becomes BUNDLE_NAME

View File

@ -1,3 +1,5 @@
# Skeleton Board
This directory contains an example of the files needed to configure the
firmware for a specific RusEFI board.

View File

@ -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

View File

@ -1 +1,3 @@
Here we have logic related to engine contol activitied within each engine cycle: coils & injectors mostly.
# Engine Cycle
Here we have logic related to engine contol activitied within each engine cycle: coils & injectors mostly.

View File

@ -1 +1,3 @@
This folder has code related to communication with the human behind the steering wheel: tachometer, check engine light, LCD etc etc.
# Gauges
This folder has code related to communication with the human behind the steering wheel: tachometer, check engine light, LCD etc etc.

View File

@ -1,3 +1,5 @@
# Generated Code
All the code here was generated by tools.
See gen_config.bat

View File

@ -1 +1,2 @@
In this folder we have files related to hubrid hardware/software timer, including PWM generation.
# Timer
In this folder we have files related to hubrid hardware/software timer, including PWM generation.

View File

@ -1 +1,3 @@
This folder is and should not be aware of engine.h or engine_configuration.h
# Trigger Decoders
This folder is and should not be aware of engine.h or engine_configuration.h

View File

@ -1 +1,2 @@
In this folder we have 3rd party code
# Ext Algo
In this folder we have 3rd party code

View File

@ -1 +1,2 @@
Completely default project as generated by MC33816 Dev Studio conveniently comes with default source code.
# MC33816 Default Project
Completely default project as generated by MC33816 Dev Studio conveniently comes with default source code.

View File

@ -1 +1,2 @@
# Hardware Layer
https://github.com/rusefi/rusefi/wiki/ASIC

View File

@ -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)
![TS](0 - 2 Tuning menu (2-47).png)

View File

@ -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.
A: please PR only rusefi.input. Once merged, gen_config.bat would be executed automatically and results would be pushed by automation.

View File

@ -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\
For example C:\Program Files (x86)\EFIAnalytics\TunerStudioMS\content\

View File

@ -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.
Ideally, code from this folder should not depend on code from any other folder.