Skip to content

Doc: switch Doxygen theme#373

Merged
athre0z merged 1 commit intomasterfrom
doxygen-tweaks
Aug 1, 2022
Merged

Doc: switch Doxygen theme#373
athre0z merged 1 commit intomasterfrom
doxygen-tweaks

Conversation

@athre0z
Copy link
Copy Markdown
Member

@athre0z athre0z commented Jul 30, 2022

This PR replaces the previous m.css theme with doxygen-awesome-css.

While m.css looks great, it has a bunch of problems when used with C. Namely, it generates all symbols and function names in C++ style and doesn't support nested structures well at all. It also had a tendency of somehow omitting documentation for some types. A lot of these issues are down to m.css having a custom HTML generator and thus having to explicitly support each of these features.

The theme that this PR switches to, doxygen-awesome-css, takes the much simpler route of re-styling the existing HTML with CSS and should thus be a lot less prone to errors.

Live demo: https://zydis.re/doc/4/modules

@athre0z athre0z added C-enhancement Category: Enhancement of existing features A-doc Area: Documentation P-medium Priority: Medium labels Jul 30, 2022
@athre0z athre0z marked this pull request as ready for review July 30, 2022 19:09
@athre0z athre0z merged commit 0897c27 into master Aug 1, 2022
@athre0z athre0z deleted the doxygen-tweaks branch August 1, 2022 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-doc Area: Documentation C-enhancement Category: Enhancement of existing features P-medium Priority: Medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants