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

Fix Doxygen Generation #2986

Merged
merged 7 commits into from May 9, 2024
Merged

Fix Doxygen Generation #2986

merged 7 commits into from May 9, 2024

Conversation

eXpl0it3r
Copy link
Member

@eXpl0it3r eXpl0it3r commented May 7, 2024

Description

If the HTML Help Compiler was found on Windows, the documentation generation would fail with Doxygen 1.10.0, as it can't support settings for HTML output and HTML Help output at the same time, as it did in previous versions.

As such, we disable HTML Help generation if we detect Doxygen 1.10.0 or newer - maybe one day we can introduce an upper limit, if there's ever a version without this issue.

image

Also fixed the XHTML issues reported in #2812. Turns out that doxygen always outputs XHTML, so we can't just switch to HTML5. There's still one validation error with the search, as XHTML doesn't know the attribute placeholder.

Additionally, we'll now generate documentation for everything. This fixes #2813
I'm not sure if this is the best option, but I think it's better than manually annotating all files and namespaces.

One downside or upside of this change, depending on how you look at it, is, that it won't warn about missing documentation anymore.

Left: 2.6.1
Right: This fix

image

image

Tasks

  • Tested on Linux
  • Tested on Windows
  • Tested on macOS
  • Tested on iOS
  • Tested on Android

How to test this PR?

Generate the documentation and check that the tabs "Namespaces" and "Files" aren't empty anymore.

@eXpl0it3r eXpl0it3r added this to the 2.6.2 milestone May 7, 2024
doc/CMakeLists.txt Show resolved Hide resolved
@eXpl0it3r eXpl0it3r linked an issue May 7, 2024 that may be closed by this pull request
3 tasks
doc/doxyfile.in Outdated Show resolved Hide resolved
doc/CMakeLists.txt Outdated Show resolved Hide resolved
@eXpl0it3r eXpl0it3r requested a review from kimci86 May 7, 2024 21:20
@eXpl0it3r eXpl0it3r linked an issue May 7, 2024 that may be closed by this pull request
3 tasks
@eXpl0it3r
Copy link
Member Author

Just realized I didn't address the XHTML issues reported in #2812

Fixed those now.

Copy link
Contributor

@kimci86 kimci86 left a comment

Choose a reason for hiding this comment

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

@eXpl0it3r
Copy link
Member Author

eXpl0it3r commented May 8, 2024

Copied the commits, thanks! 🙂

Works great:

chrome_qzK4hnbzrZ

Result:

// get the clipboard content as a string
sf::String string = sf::Clipboard::getString();

// or use it in the event loop
sf::Event event;
while(window.pollEvent(event))
{
    if(event.type == sf::Event::Closed)
        window.close();
    if(event.type == sf::Event::KeyPressed)
    {
        // Using Ctrl + V to paste a string into SFML
        if(event.key.control && event.key.code == sf::Keyboard::V)
            string = sf::Clipboard::getString();

        // Using Ctrl + C to copy a string out of SFML
        if(event.key.control && event.key.code == sf::Keyboard::C)
            sf::Clipboard::setString("Hello World!");
    }
}

@eXpl0it3r eXpl0it3r requested a review from kimci86 May 8, 2024 12:46
doc/header.html.in Outdated Show resolved Hide resolved
eXpl0it3r and others added 3 commits May 8, 2024 17:22
CSS rules copied from doxygen default stylesheet generated with:
    doxygen -w html new_header.html new_footer.html new_stylesheet.css
@kimci86
Copy link
Contributor

kimci86 commented May 8, 2024

We can also get icons working in the Files tab, even with nice color!

See: 44eb058

Capture d’écran du 2024-05-08 20-05-25

@eXpl0it3r eXpl0it3r merged commit b7e1a25 into 2.6.x May 9, 2024
62 checks passed
@eXpl0it3r eXpl0it3r deleted the bugfix/doxygen-docs branch May 9, 2024 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants