Core: include in documentation the doxygen output for each core_x.h file.

[flit]

The Core(M) documentation only includes limited documentation that is generated from copies of the real core header contents in the ./CMSIS/DoxyGen/Core/src/Ref_*.txt and ./CMSIS/DoxyGen/Core/src/core_cm7.txt files. This makes it difficult to find the definitions actually available for the core in which you are interested. There is also no (generated) documentation at all of, for example, v8.1-M features. Of course, this also means the documentation can easily get out of sync with the real definitions.

The proposal is to include the generated documentation from all of the header files under ./CMSIS/Core/Include.

Whether this replaces the existing generic documentation is arguable. I think I'd have to see what it looks like to get a feel for the best answer.

Core(A) should probably do the same.

[JonatanAntoni]

Hi @flit,

A problem here is, that all the core headers contain lots of redefinitions. Strictly speaking, we'd need separate pages per core. If someone would come up with a good idea how to warp the documentation into the 21st century, I'd be very happy.

Cheers, Jonatan

[flit]

Hi @JonatanAntoni, yes, I'd expect separate pages for each core. If I get some time, I'll try some experiments with organisation. Fortunately you already have very well organised doxygen groups within the core headers.