Harmonize TODO and declaration comments to Doxygen format #1262
Labels
Controller code
hardware controller project
Documentation
Improvements or additions to documentation
GUI
Graphical User Interface project
Software
Umbrella: GUI, Controller or CI
Milestone
Comments
asmodai27
added
Documentation
martukas
added a commit
that referenced
this issue
Jul 14, 2022
martukas
added a commit
that referenced
this issue
Jul 15, 2022
"further decouple clocks and gpio in HAL; updates #1184" "precommit reformat; updates #1184" "update headers; updates #1184" "templated sensor classes; updates #1184" "abstracted Sensors class and disentangled sensor tests; updates #1184" "some cleanup and abstraction of actuators container; updates #1184" "decoupling some of the debug interface modules; updates #1184" "initialize comms UARTs outside of HAL::init; updates #1184" "no more static globals other than HAL; updates #1184" "some cleanup; updates #1184" "new harware layer fully abstracts v0.3 specifics; updates #1184" "new god object for main.cpp; updates #1184" "fixed debugger initialization; updates #1184" "cleanup and fixed syntax for TODOs; updates #1262; updates #1184" "Addressing PR and moving more initializition code to v03system; updates #1184" "idle integration test should shut down blower; updates #1184" "more integration test fixes; updates #1184" "even more integration test fixes; updates #1184" "eeprom integration test fix; updates #1184" "eeprom integration test fix 2; updates #1184" "eeprom integration test fix 3; updates #1184" "debug script more tolerant of version errors; updates #1184" "some cleanup and addressing review; updates #1184" Update software/controller/lib/debug/interface.h Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> Update software/controller/lib/core/v03system.cpp Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> "static check fixes; updates #1184" Update software/controller/lib/core/comms.h Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> "addressing remainingh review comments; updates #1184"
martukas
added a commit
that referenced
this issue
Jul 15, 2022
"further decouple clocks and gpio in HAL; updates #1184" "precommit reformat; updates #1184" "update headers; updates #1184" "templated sensor classes; updates #1184" "abstracted Sensors class and disentangled sensor tests; updates #1184" "some cleanup and abstraction of actuators container; updates #1184" "decoupling some of the debug interface modules; updates #1184" "initialize comms UARTs outside of HAL::init; updates #1184" "no more static globals other than HAL; updates #1184" "some cleanup; updates #1184" "new harware layer fully abstracts v0.3 specifics; updates #1184" "new god object for main.cpp; updates #1184" "fixed debugger initialization; updates #1184" "cleanup and fixed syntax for TODOs; updates #1262; updates #1184" "Addressing PR and moving more initializition code to v03system; updates #1184" "idle integration test should shut down blower; updates #1184" "more integration test fixes; updates #1184" "even more integration test fixes; updates #1184" "eeprom integration test fix; updates #1184" "eeprom integration test fix 2; updates #1184" "eeprom integration test fix 3; updates #1184" "debug script more tolerant of version errors; updates #1184" "some cleanup and addressing review; updates #1184" Update software/controller/lib/debug/interface.h Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> Update software/controller/lib/core/v03system.cpp Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> "static check fixes; updates #1184" Update software/controller/lib/core/comms.h Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> "addressing remainingh review comments; updates #1184"
a-vinod
pushed a commit
that referenced
this issue
Jul 16, 2022
"further decouple clocks and gpio in HAL; updates #1184" "precommit reformat; updates #1184" "update headers; updates #1184" "templated sensor classes; updates #1184" "abstracted Sensors class and disentangled sensor tests; updates #1184" "some cleanup and abstraction of actuators container; updates #1184" "decoupling some of the debug interface modules; updates #1184" "initialize comms UARTs outside of HAL::init; updates #1184" "no more static globals other than HAL; updates #1184" "some cleanup; updates #1184" "new harware layer fully abstracts v0.3 specifics; updates #1184" "new god object for main.cpp; updates #1184" "fixed debugger initialization; updates #1184" "cleanup and fixed syntax for TODOs; updates #1262; updates #1184" "Addressing PR and moving more initializition code to v03system; updates #1184" "idle integration test should shut down blower; updates #1184" "more integration test fixes; updates #1184" "even more integration test fixes; updates #1184" "eeprom integration test fix; updates #1184" "eeprom integration test fix 2; updates #1184" "eeprom integration test fix 3; updates #1184" "debug script more tolerant of version errors; updates #1184" "some cleanup and addressing review; updates #1184" Update software/controller/lib/debug/interface.h Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> Update software/controller/lib/core/v03system.cpp Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> "static check fixes; updates #1184" Update software/controller/lib/core/comms.h Co-authored-by: Jérôme Travert <asmodai27@users.noreply.github.com> "addressing remainingh review comments; updates #1184"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Change the format of some
// TODO XXXand some class/function definitions comments to Doxygen parseable comments (https://doxygen.nl/manual/docblocks.html):The option which would integrate best with our current codestyle is
/// \TODO Do something,/// \brief Function descriptionand so on.Update our current style guide to encourage this and our PR checklist to remind contributors about Doxygen markup.
How do you know it has to be done
Per PR reviews.
If done properly, this has potential to generate a comprehensive documentation for all of our modules automatically.
The text was updated successfully, but these errors were encountered: