docs: private firmware enums vs public to code generated

This commit is contained in:
rusefillc 2022-09-23 09:41:13 -04:00
parent b76a7cbcd8
commit 9fde1f8b61
2 changed files with 7 additions and 1 deletions

View File

@ -1,6 +1,9 @@
/*
* @file engine_types.h
*
* See 'integration API' note in rusefi_enums.h
* TODO: spell out which enums belong here and which enums belong in rusefi_enums.h for what reasons
*
* @date Oct 23, 2021
* @author Andrey Belomutskiy, (c) 2012-2021
*/

View File

@ -1,6 +1,9 @@
/**
* @file rusefi_enums.h
* @brief Fundamental rusEfi enumerable types live here
* @brief Fundamental rusEFI enumerable types live here
*
* This and few over headers are part of integration API between C/C++ and code generator for memory meta and java code.
* TODO: move enums which should not be visible outside of the firmware out of 'integration API' headers like this one
*
* @note this file should probably not include any other files
*