Parsing issue on RTEMS

[kiwichris]

Hi,

I decided to try your tool on RTEMS (https://gitlab.rtems.org/rtems/rtos/rtems) and it does not like bsps/arm/imxrt/mcux-sdk/devices/MIMXRT1166/MIMXRT1166_cm7.h so I thought I would let you know.

I built doxide on FreeBSD 14.1 (needed to add /usr/local/include and /usr/local/lib) and then:

doxide init
doxide build

After a bit the warnings and issues appeared

Thanks Chris

[lawmurray]

Thanks for the report @kiwichris, I'll have a look!

[lawmurray]

I've had a look into this @kiwichris. It's a large and complex code base that really puts Doxide through its paces. The parse errors are mostly coming from extensive macro use. They do not seem to be fatal, in that parsing just continues anyway, but it may affect the final presentation. The code also makes heavy use of Doxygen commands that Doxide does not support, as well as Doxygen-style groups with e.g. @defgroup that, again, Doxide does not support (groups are defined in the config file instead).

So I don't expect that Doxide will be able to handle a code base like this without a conversion effort. But there was some value in the exercise and I've made a few small fixes for the next release. They include removing some of the autocorrection features for parse errors that were problematic in this case (causing an infinite loop in fact), and reducing some of the noise by warning only once for each unrecognized command and group. That won't get Doxide working smoothly for RTEMS documentation, but it may help with other code bases.

I'll close the issue now as that's as far as it can be addressed at this stage.

[kiwichris]

Thanks for taking the time to have a look and fix some issues. You feedback is great. It is large complex code base and it contains some 3rd party code with a lot of doxygen related comments we cannot change. All the best and if groups get supported I would love to rerun and try again.