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
Fix Doxygen Generation #2986
Conversation
4e2cd6f
to
b2abacb
Compare
b2abacb
to
2dc5c67
Compare
Just realized I didn't address the XHTML issues reported in #2812 Fixed those now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions: bugfix/doxygen-docs...kimci86:SFML:bugfix/doxygen-docs
Copied the commits, thanks! 🙂 Works great: 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!");
}
} |
CSS rules copied from doxygen default stylesheet generated with: doxygen -w html new_header.html new_footer.html new_stylesheet.css
8896319
to
9111429
Compare
We can also get icons working in the Files tab, even with nice color! See: 44eb058 |
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.
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
Tasks
How to test this PR?
Generate the documentation and check that the tabs "Namespaces" and "Files" aren't empty anymore.