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

docs: update doxygen output #1009

Merged
merged 1 commit into from
Jul 31, 2023
Merged

docs: update doxygen output #1009

merged 1 commit into from
Jul 31, 2023

Conversation

DSCaskey
Copy link
Contributor

@DSCaskey DSCaskey commented Jul 30, 2023

  • This updates the Doxygen documents to output in dark mode

  • Adds a link in the README-DEVELOPER.md to the Doxygen Documents.

  • Fixes the broken License link in README.md

Note: to @csett86 The Doxygen html documents should be output to an html directory, as we can also output other formats, but hey If you think it's a good idea to not put html docs in an html directory....

@DSCaskey DSCaskey requested a review from slspencer July 30, 2023 20:17
@DSCaskey DSCaskey self-assigned this Jul 30, 2023
@what-the-diff
Copy link

what-the-diff bot commented Jul 30, 2023

✨ PR Summary

Brilliant work team! 😄 Let's have a look at the sweet improvements crafted in this Pull Request:

  • Enhanced Documentation Guidance for Developers 📖
    The Developer Readme now boasts a fresh 'Code Documentation' section guiding our cherished developers to doxygen documentation, which makes navigating through code quite a breeze!

  • Fresh Links in Main Readme 🔗
    The primary Readme has an updated link leading straight to the LICENSE.md file. No more scavenger hunts for licensing details!

  • Enhanced Aesthetics for Doxygen 😎
    With the QT_AUTOBRIEF flag switched to NO in Doxyfile, we say goodbye to auto brief descriptions. This encourages our devs to put in concise, yet informative descriptions for code!

And guess what? We're also going Dark mode with HTML_COLORSTYLE set to DARK. No more glaring bright pages, binge coding sessions are now more comfortable! 🌔

Every single change contributes to better clarity, comfort, and navigation. So let’s keep the coding environment enjoyable and productive! 🚀 😍 Keep rocking it!

@ghost
Copy link

ghost commented Jul 30, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@DSCaskey DSCaskey added the CI Continuous Integration label Jul 30, 2023
Copy link
Collaborator

@csett86 csett86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks for incorporating all the suggestions!

@csett86 csett86 merged commit 408540f into develop Jul 31, 2023
10 checks passed
@csett86 csett86 deleted the docs-update-doxygen branch July 31, 2023 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants