-
Notifications
You must be signed in to change notification settings - Fork 143
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix Doxygen Documentation Generator #102
Conversation
3797df9
to
40ab0bf
Compare
4d73c78
to
47b4126
Compare
I'm removing the whitespace changes from this PR and putting them in a separate one, otherwise this becomes very messy. |
\o/ |
Yeah, this makes modm much more accessible for third parties. I thought you'd like this ;-P |
Unfortunately, while applying whitespace removal I accidentally my whole |
This is a massive PR with a lot of small artisan changes to the documentation
followed by a huge whacking of trailing whitespace removals for good measure.This makes the
modm:docs
module generate the doxygen module structure by defining its groups and including the module description in it. This way the module description can be shared between thelbuild discover
commands and doxygen.To support this however, all modm modules had to be refactored to name the right
@ingroup modm_module_submodule
. I've also added a lot of missing classes into their respective groups.Every lbuild module now also has a description, or at least a description title.
With this PR you can
cd modm/docs; doxygen doxygen.cfg
and the fully featured documentation will appear magically undermodm/docs/html/
for your specific target.cc @strongly-typed @daniel-k @mhthies @rleh @chris-durand