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

Add Doxyfile configurations and update Doxygen plugin #98

Merged
merged 4 commits into from
Apr 2, 2024

Conversation

JakubAndrysek
Copy link
Owner

No description provided.

@JakubAndrysek JakubAndrysek linked an issue Apr 2, 2024 that may be closed by this pull request
@JakubAndrysek JakubAndrysek merged commit 7a65af2 into main Apr 2, 2024
26 checks passed
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JakubAndrysek - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 3 issues found
  • 🟢 Complexity: all looks good
  • 🟢 Docstrings: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

assert result == expected_result


# Sets the Doxygen configuration using a custom config file
Copy link

Choose a reason for hiding this comment

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

suggestion (testing): Add assertions for the presence of custom configurations in test_set_doxy_cfg_custom_file.

The test currently checks for default configurations being set correctly. It would be beneficial to also assert that any custom configurations provided through the doxyCfgNew parameter are applied correctly. This ensures that custom configurations are not ignored or overwritten by default values.

@@ -0,0 +1,89 @@
from mkdoxy.doxyrun import DoxygenRun
Copy link

Choose a reason for hiding this comment

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

suggestion (testing): Add tests for hashWrite and hashRead functions.

These functions are crucial for determining whether the source files have changed since the last run. Testing them would ensure that changes are correctly detected, leading to appropriate Doxygen runs.

@@ -0,0 +1,89 @@
from mkdoxy.doxyrun import DoxygenRun
Copy link

Choose a reason for hiding this comment

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

suggestion (testing): Include tests for hasChanged method.

This method plays a key role in deciding whether to run Doxygen based on changes to the source files. Tests should cover scenarios where files have changed, haven't changed, and edge cases like new files being added or removed.

@JakubAndrysek JakubAndrysek deleted the doxygen-config-file branch April 2, 2024 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using doxygen config file
1 participant