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.

Sign up for GitHub

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

Jump to bottom

Add Doxygen documentation #51

Merged
merged 9 commits into from
Sep 13, 2020
Merged

Add Doxygen documentation #51

merged 9 commits into from
Sep 13, 2020

Conversation

speshak
Copy link
Contributor

@speshak speshak commented Sep 13, 2020

  • Adds the comments to a large chunk of code
  • Adds a GitHub action to automatically publish the docs to GitHub Pages
  • Cleans up some code noticed while documenting.

I wouldn't say this Fixes #49, but it certainly moves the ball forward on it.

thorrak and others added 7 commits September 3, 2020 07:35
@thorrak @speshak
Tweak FS code
ee67cba
@speshak
Add doxygen comments to FilterCascaded and cleanup
f144d19 
Refactor out NUM_SECTIONS preprocessor macro into a constexpr.  This
change doesn't effect the compiled code but tightens up the scoping/type
safety.

Refactored out duplicated code in both the constructor and the
setCoefficients method.
@speshak
Add doxygen comments
a76b2a9
@speshak
Add doxygen configuration file
7410022
@speshak
Use GitHub action to build & publish doxygen docs
00cbf04
@speshak
Refactor 1W precision define into class member constexpr
9564fa7 
This should be a no-op after compiling, but tightens up namespacing and
type safety.

This change also includes Doxygen documentation improvements.
@speshak
Ignore Doxygen generated files & vim swap files
439883f
@CLAassistant
Copy link

CLAassistant commented Sep 13, 2020 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@speshak
Copy link
Contributor Author

speshak commented Sep 13, 2020

This is viewable here: https://speshak.github.io/brewpi-esp8266/
I'm going to push another commit to limit the publishing Action to only run on master. That's probably the more preferred behavior.

@thorrak thorrak merged commit c5b158d into thorrak:esp32 Sep 13, 2020
@speshak speshak deleted the cleanup_and_docs branch September 13, 2020 03:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thorrak thorrak thorrak approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@speshak @CLAassistant @thorrak