Adding Doxygen 1.14.0 compatibility ✨

This release adds the long overdue adjustments to support Doxygen 1.14.0. The new release of Doxygen introduced many changes that made updating the theme challenging. Nonetheless, this new version of doxygen-awesome.css aims to be fully backwards compatible with older versions of Doxygen!
If you find any artifacts in older versions of Doxygen that have been introduced by this release, please open an issue!

Added

• New helper classes are available in doxygen-awesome.css by default:
  • primary-button helps to add simple buttons in the documentation. (d9625b1)
  • bordered-image adds a rounded border to images. (5383b16)
  • darkmode_inverted_image allows images to automatically switch to dark mode with a CSS filter. (5383b16)
• The new variable --on-primary-color can be used to customize text on top of a primary color background. (98dd024)
• The new variable --link-color allows you to customize the color of hyperlinks independently from --primary-color. (cda456d)
• The new page outline panel introduced in Doxygen 1.14.0 is now supported. If you still want to use the Interactive TOC extension instead, PAGE_OUTLINE_PANEL=NO must be set in the Doxyfile. (48bc38a)

Changed

• The icons for the code copy button have been updated. (03d60e3)
  
• Border radii have been slightly increased in the default theme. (fca7f3d)
• Hyperlinks are now underlined on hover. (0ead5e6)

Fixed

• Many issues with Doxygen 1.14.0 have been fixed. Among them are:
  • Visual errors in the nav-path breadcrumbs. (461ab33)
  • Missing subtree arrows in the sidebar. (29798c8)
  • Issues with the class member documentation. (45a13f0)
  • A slight offset in the new search icon. (6503794)
  • Broken inline code blocks. (a414cd6)
  • and many more...

New Contributors

• @comkieffer made their first contribution in #161
• @timokoch made their first contribution in #178
• @pinchartl made their first contribution in #191
• @AdhTri001 made their first contribution in #190
• @higaski made their first contribution in #179

Full Changelog: v2.3.4...v2.4.0

Another Maintenance Release

This release brings support for Doxygen 1.12.0 and some other small fixes.

Thanks to @CaseyNelson314, @iamAyushChamoli, @murillo-teixeira, @legerch, @winterz for their contributions that made this release possible!

Changed

• The example Doxyfile was updated to Doxygen 1.12.0. (fae4145)
• Overflowing text in the navigation sidebar will now be displayed with an ellipsis. (cc1bee0)

Fixed

• Scrolling on a page with a TOC and a large number of headers is now more performant and does not lag anymore. Fixes #147. (28ed396)
• The SHOW_ENUM_VALUES option from Doxygen 1.12.0 is now supported. (3ef7504)
• The documentation now mentions that HTML_COPY_CLIPBOARD must be set to NO. Fixes #142. (00c7339)

Full Changelog: v2.3.3...v2.3.4

Maintenance Release

Thanks to @VolkerEnderlein, @OleksandrKvl and @marktsuchida for contributing bug reports and pull requests to this release!

Fixed

• Markdown separators do not overlay TOC anymore. Fixes #138. (9f97817)
• Function parameter coloring has been improved for Doxygen 1.10. Fixes #139. (a7ec802)

Full Changelog: v2.3.2...v2.3.3

A Small Maintenance Release 👀

Fixed

• The TOC sidebar does now use the same font as the rest of the page. Fixes #131. (998eaf3)
• Tabs can now contain lists. Fixes #132. (c01e51e)
• Visual artifacts in the navigation tree appearing in Doxygen 1.10.0 have been removed. Fixes #136. (c4a2f64)

Release fix for npm 🤦‍♂️

Nothing to see here! This release only fixes the package.json version. The new version can now be installed with npm as expected.

Changed

• The documentation was slightly improved. (b5d5b27)

Fixed

• I messed up the v2.3.0 release by forgetting to update the package.json version field. Fixes #130. (df88fe4)

Colors, Tabs and Navigation Buttons 🕺

This release brings better compatibility with Doxygen 1.9.8, official support for page navigation buttons and improved tabs.

Thanks to @mr-c, @david-alvarez-rosa, @patricklaf, @dsieger and @traversebitree for reporting bugs, opening pull requests and providing feedback that influenced this release!

Added

• Official support for page navigation buttons was added. (db7f670, 4f33788, 9796bbf)
  
  They were originally introduced as a custom extension for the demo page, but people seemed to like them, so they are now part of doxygen-awesome.css. This feature is based on MR #120 by @patricklaf.
  Instructions on setting up page navigation can be found here.

Changed

• The coloring of text blocks like "note", "warning", "error", etc. was improved based on pmp-library/pmp-library@54e8e75. Fixes #123 (3831e5c)
• The Tabs extension was slightly improved. The height of the tab content is now always set to the maximum required space.
  This prevents unwanted jumping of the content below when tabs are changed. Also the appearance of the tabs was improved.
  Be aware that this feature is still considered experimental! (fa53db2, 20a0c45)

Fixed

• The Makefile does now install the Tabs extension as well. (00a52f6)
• Code Fragments are now working as expected in Doxygen 1.9.8. Fixes #128. (c064ec1)

Full Changelog: v2.2.1...v2.3.0

Installation with npm 🐥

Doxygen 1.9.7 is out and is compatible with this version.

Thanks to @ilg-ul and @manzerbredes for reporting bugs, opening pull requests and providing feedback that influenced this release!

Added

• A package.json was added to the repository, which allows to install this theme with npm or xpm: npm install https://github.com/jothepro/doxygen-awesome-css#v2.2.1 --save-dev (7ea6939)

Changed

• The style of the tabs extension was slightly improved. (f54bc54)

Fixed

• The side-nav container now has a min and max width to avoid that it gets stuck in an unrecoverable state when resized. Fixes #115. (2959339)
• The side-nav resize handle area was increased to 4px to allow easier resizing. Unfortunately this fix only works on macOS for now. (2959339)

Full Changelog: v2.2.0...v2.2.1

Graphviz support, Tabs and Bugfixes 🥁

Doxygen 1.9.6 is out and supported by this version!

Thanks to @Tachi107, @asmaloney, @StefanBattmer, @tim-gromeyer and @MuellerSeb for reporting bugs, opening pull requests and providing feedback that influenced this release!

Added

• The new experimental "tabs" extension allows to format list content as tabs. Detailed documentation can be found here. Be warned that it might be buggy, I haven't tested it extensively yet! (dd9216c)
  
• User-defined Graphviz graphs are now supported. They are inverted in dark-mode and can be scrolled if they are too wide to fit. (a6b9f1e, bbaaea4)
  
• A Makefile was added to support easy installation with the command make install. (8a34f70)
• Added support for postcondition blocks @post. (73c3019)
• Added documentation and a support class that helps with table formatting: Tables can now be centered or can fill the whole page width. Detailed documentation can be found here. (7b9598a)

Fixed

• Tables are not cut off on the sides anymore when centered. Fixes #91. (05fa388)
• The nav-tree sidebar can now be resized in Chrome on Windows. It is still just 1px wide though and thereby hard to grab. I may address this in a future release 🤔 . Fixes #106. (74a129b)

Full Changelog: v2.1.0...v2.2.0

Going down the rabbit hole 🐰

This release attempts to polish small things that have been overlooked up to this point. The closer I started looking, the more details needed refinement, which is why there is plenty of changes in this new version that you probably won't even notice. 😨

Also, a big new feature is introduced: A totally redesigned Table of Contents!

Many thanks to @leissa, @artem-ogre, @oblivioncth, @cadop and @McSnipe97 for reporting bugs and providing feedback that influenced this release!

Added

• Compatibility for Doxygen 1.9.5 has been improved. (5bf1d5f)
  Nervertheless it recommended to skip 1.9.5 and update directly to 1.9.6 once it is released! 1.9.5 comes with styled scrollbars that don't play well with this theme: doxygen/doxygen#9549
• Doxygen tables are now supported. (9e46639)
• Custom styling for some expand/collapse arrows was added. (74b4250, fe37c76)
• Anchors to a line in a code listing are now supported. (a27f39e)
• The Table of Contents (TOC) on documentation pages has been redesigned! 👏 (9e3712c, 4621dc4, 7221204)
  On large screens, the TOC is now anchored to the top right of the page. This means that it is always accessible, even when scrolling through a long document.
  An optional Javascript extension that interactively highlights the current read progress is provided in doxygen-awesome-interactive-toc.js. When the extension is enabled, on small screens the TOC is also hidden by default to save some screen space:
  

Changed

• Some small layout adjustments where made. (06ffe6d, 0d3ef53, 51a8ce0)

Fixed

• Fixed the searchbar for older versions of Doxygen (v1.8.x): (bf51192)
  • the searchbar image is not squashed anymore.
  • background image artifacts in the searchbar are removed.
• Images in tables are not inverted anymore. (afc4868)
• The layout for long templated functions was improved. (c6568eb)

Full Changelog: v2.0.3...v2.1.0

Some more fine tuning ✨

Changed

• The treeview selection indicator is now rounded. (10cf1bf)
  

Fixed

• Some small issues with the new scrollbar styling have been resolved: (2b51cd4, ccedae8)
• The styling for C++ template types in the member function documentation has been fixed. (a933556)