Skip to content
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

Merged
merged 21 commits into from
Oct 15, 2018

Conversation

salkinium
Copy link
Member

@salkinium salkinium commented Oct 14, 2018

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 the lbuild 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 under modm/docs/html/ for your specific target.

cc @strongly-typed @daniel-k @mhthies @rleh @chris-durand

@salkinium
Copy link
Member Author

Here are all of the modules for the F469 blink example:

screenshot 2018-10-14 at 23 15 43 screenshot 2018-10-14 at 23 15 56
screenshot 2018-10-14 at 23 16 07screenshot 2018-10-14 at 23 16 16

@salkinium salkinium force-pushed the feature/doxygen-groups branch 2 times, most recently from 3797df9 to 40ab0bf Compare October 14, 2018 21:35
@salkinium salkinium force-pushed the feature/doxygen-groups branch 2 times, most recently from 4d73c78 to 47b4126 Compare October 15, 2018 11:28
@salkinium
Copy link
Member Author

I'm removing the whitespace changes from this PR and putting them in a separate one, otherwise this becomes very messy.

@salkinium salkinium merged commit 47b4126 into modm-io:develop Oct 15, 2018
@daniel-k
Copy link
Contributor

\o/

@salkinium salkinium deleted the feature/doxygen-groups branch October 15, 2018 11:55
@salkinium
Copy link
Member Author

\o/

Yeah, this makes modm much more accessible for third parties. I thought you'd like this ;-P
Now we only need to address the level of detail of documentation not its complete lack of. *phew*

@salkinium
Copy link
Member Author

Unfortunately, while applying whitespace removal I accidentally my whole .git/objects/* folder recursively.
So I lost some important scripts that I need to generate the homepage documentation. I plan to brute force the missing bits (space and tab values preceding newline, ie. trailing whitespace) to make the object files match their sha again. Wish me luck.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants