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.

Sign up for GitHub

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

Jump to bottom

Add support for whole spec of doxygen config format #121

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Add support for whole spec of doxygen config format #121

merged 2 commits into from
Jan 15, 2025

Conversation

athackst
Copy link
Contributor

@athackst athackst commented Dec 13, 2024 •
edited by sourcery-ai bot
Loading

Adds support for the complete spec for doxygen config file formats.

Closes #115

Summary by Sourcery

Add support for the complete specification of Doxygen configuration file formats, including handling of comments and multi-line values. Update the parsing logic to accommodate new operators and patterns, and introduce a test case to validate the expanded configuration parsing.

New Features:

  • Add support for parsing the complete specification of Doxygen configuration file formats.

Tests:

  • Introduce a new test case to verify the expanded configuration parsing for Doxygen config files.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Dec 13, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This PR enhances the Doxygen configuration file parsing functionality by adding support for the complete Doxygen configuration format specification. The implementation adds handling for comments, line continuations, and the '+=' operator for appending values to existing configuration parameters.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Enhanced Doxygen configuration string parsing with support for additional syntax features
  • Added support for line continuation using backslash
  • Added support for comment lines starting with '#'
  • Implemented '+=' operator for appending values to existing parameters
  • Improved regex pattern matching for key-value extraction
  • Maintained existing YES/NO to boolean conversion
 mkdoxy/doxyrun.py
Added comprehensive test cases for new configuration parsing features
  • Added test case for empty PROJECT_LOGO value
  • Added test for multi-line values with line continuation
  • Added test for the '+=' operator with FILE_PATTERNS
  • Added test for comment handling
 tests/test_doxyrun.py

Assessment against linked issues

Issue Objective Addressed Explanation
#115 Add support for multi-line configuration using backslash ✅
#115 Add support for comments starting with # ✅
#115 Add support for list concatenation using += ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Dec 13, 2024
View reviewed changes
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 @athackst - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: 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 and I'll use the feedback to improve your reviews.

julianeisel
julianeisel reviewed Jan 14, 2025
View reviewed changes
Copy link

@julianeisel julianeisel left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I ran into these limitations when running MkDoxy with Blender's Doxyfile. I'd guess even the default Doxyfile would fail since it contains comments.

Wanted to submit my own PR, saw this and - works perfectly! All config values seem to be read correctly.

tests/test_doxyrun.py Show resolved Hide resolved
mkdoxy/doxyrun.py Outdated Show resolved Hide resolved
@JakubAndrysek
Copy link
Owner

Hi, sorry for the late response. I will look at it in the evening.

Thank you for your help.

@JakubAndrysek JakubAndrysek merged commit 7b25eda into JakubAndrysek:main Jan 15, 2025
@julianeisel julianeisel mentioned this pull request Jan 17, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@julianeisel julianeisel julianeisel left review comments

@JakubAndrysek JakubAndrysek JakubAndrysek approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support full doxygen config file format
3 participants
@athackst @JakubAndrysek @julianeisel