search

svenevs / exhale

Automatic C++ library api documentation generation: breathe doxygen in and exhale it out.
BSD 3-Clause "New" or "Revised" License
218 stars 51 forks source link

Does it work for C projects? #181

Open SadE54 opened 1 year ago

SadE54 commented 1 year ago

I'm just starting to play with sphinx and breathe before realizing I have to write myself all the toc 😭 Until I discovered exhale... just hoping now it s working well for C projects 😬

svenevs commented 1 year ago

Hey! Quick response from phone, C++ got most of the attention but I'm hopeful it'll work well with C (that's really on doxygen). I know PHP has problems though.

https://github.com/svenevs/exhale/tree/master/testing%2Fprojects%2Fc_maths

That C project works as expected but it's very very simple.

I think it's worth a shot but there may be some areas that need improvement here. If you're project is open source feel free to link and I'll try and help out! Otherwise feel free to ask questions here if you get stuck (post error messages) and hopefully we can get it working 🙂 The machinery involved (sphinx, doxygen, breathe, exhale) is confusing and complicated for everyone including myself...