feat: add function in namespace snippet

[barnou-psee]

Summary by Sourcery

Add functionality to support namespace-specific function documentation by introducing doxyNamespaceFunction in finder.py and updating generatorSnippets.py to handle this new feature. Update the documentation to reflect these changes.

New Features:

• Introduce a new function doxyNamespaceFunction in the finder.py to locate functions within a specific namespace.

Enhancements:

• Add support for namespace.function in generatorSnippets.py to handle namespace-specific function documentation.

Documentation:

• Update functions.md to include documentation for the new doxy.<project>.namespace.function tag, explaining its usage and parameters.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR adds support for documenting functions within namespaces by introducing a new documentation tag '::: doxy..namespace.function'. The implementation includes new finder methods for namespaces and namespace functions, along with corresponding generator functionality.

Class diagram for updated finder methods

classDiagram
    class Finder {
        +doxyClass(project, className: str)
        +doxyNamespace(project, namespace: str)
        +doxyClassMethod(project, className: str, methodName: str)
        +doxyNamespaceFunction(project, namespace: str, functionName: str)
        +doxyFunction(project, functionName: str)
    }
    note for Finder "Added doxyNamespace and doxyNamespaceFunction methods"

Loading

Class diagram for updated generator snippets

classDiagram
    class GeneratorSnippets {
        +doxyNamespaceList(snippet, project: str, config)
        +doxyNamespaceFunction(snippet, project: str, config)
        +doxyFileList(snippet, project: str, config)
    }
    note for GeneratorSnippets "Added doxyNamespaceFunction method"

Loading

File-Level Changes

Change	Details	Files
Added new documentation tag for namespace functions	Added documentation for the '::: doxy..namespace.function' tag Added example usage and error message documentation Included parameter description table	docs/snippets/functions.md
Implemented namespace and namespace function finder methods	Added doxyNamespace method to find namespace nodes Added doxyNamespaceFunction method to find functions within namespaces Implemented recursive search functionality for namespace functions	mkdoxy/finder.py
Added namespace function generator support	Added 'namespace.function' to doxy_arguments dictionary Implemented doxyNamespaceFunction generator method Added error handling and link prefix configuration	mkdoxy/generatorSnippets.py

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @barnou-psee - I've reviewed your changes - here's some feedback:

Overall Comments:

• Error message in doxyNamespaceFunction references 'Class' instead of 'Namespace' in the error text - this should be updated to match the actual functionality

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[JakubAndrysek]

I have tested it in a new environment.

Main branch

---

This branch  Do you have the same result?

[barnou-psee]

Hello, sorry I executed mkdocs serve and this is what I have on my PR after some bugfix:

[JakubAndrysek]

Thank you for the help, merged in https://pypi.org/project/mkdoxy/1.2.6/