Direction tags

[tomschmitz98]

This adds support for parameter direction tags (in, out, and in,out). This closes out issue #78.

Summary by Sourcery

New Features:

• Display parameter direction annotations (in, out, in/out) in the parameter description output.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds support for rendering Doxygen parameter direction tags (in, out, inout) into the generated markdown by prefixing parameter descriptions with a formatted direction label.

File-Level Changes

Change	Details	Files
Render parameter direction tags from Doxygen XML into markdown output for parameter descriptions.	Inspect the parameter name element for a 'direction' attribute when building the parameter paragraph. Map 'inout' to a '[in/out] ' prefix while mapping other direction values directly to '[] ' prefixes. Prepend the computed direction tag text to the parameter description paragraph before existing name/description handling logic.	mkdoxy/xml_parser.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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

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 there - I've reviewed your changes - here's some feedback:

• You access name.attrib before checking that name is not None, so if parameteritem.find("parameternamelist").find("parametername") returns None this will raise an exception; consider moving the direction handling below the existing if name is not None guard.
• The special-casing of only the "inout" direction while directly echoing any other direction attribute value could surface unexpected tags; if the valid values are known, consider validating or normalizing them (e.g., mapping only in, out, and inout) rather than blindly interpolating.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- You access `name.attrib` before checking that `name` is not `None`, so if `parameteritem.find("parameternamelist").find("parametername")` returns `None` this will raise an exception; consider moving the `direction` handling below the existing `if name is not None` guard.
- The special-casing of only the `"inout"` direction while directly echoing any other `direction` attribute value could surface unexpected tags; if the valid values are known, consider validating or normalizing them (e.g., mapping only `in`, `out`, and `inout`) rather than blindly interpolating.

## Individual Comments

### Comment 1
<location> `mkdoxy/xml_parser.py:240` </location>
<code_context>
                     name = parameteritem.find("parameternamelist").find("parametername")
                     description = parameteritem.find("parameterdescription").findall("para")
                     par = MdParagraph([])
+                    if "direction" in name.attrib:
+                        if name.attrib["direction"] == "inout":
+                            par.append(Text("[in/out] "))
</code_context>

<issue_to_address>
**issue:** Guard against `name` being `None` before accessing `.attrib` to avoid potential runtime errors.

The new logic uses `name.attrib` before the `if name is not None` check. If `parameteritem.find("parameternamelist").find("parametername")` returns `None`, this will raise an `AttributeError`. Consider moving the `direction` handling inside the existing `if name is not None` block, or explicitly guarding it:

```python
if name is not None and "direction" in name.attrib:
    if name.attrib["direction"] == "inout":
        par.append(Text("[in/out] "))
    else:
        par.append(Text(f"[{name.attrib['direction']}] "))
```

This preserves the behavior while avoiding crashes on malformed or unexpected XML.
</issue_to_address>

---

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.}