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 support for formatting the new Doxygen types using MarkupFormatter #163

Merged
merged 6 commits into from
Feb 6, 2024

Conversation

j-f1
Copy link
Contributor

@j-f1 j-f1 commented Feb 6, 2024

Bug/issue #, if applicable: N/A, follow-on from #159

Summary

When adding the new node types, I missed a couple places. One was the documentation page, which this PR fixes. More seriously, MarkupFormatter currently crashes when fed these new node types, so I’ve added formatter support there and also refactored the code a bit to simplify it.

Dependencies

None.

Testing

./bin/test. Let me know if there is anything else you’d like me to add to the test suites.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@j-f1
Copy link
Contributor Author

j-f1 commented Feb 6, 2024

@swift-ci please test

Copy link
Contributor

@Kyle-Ye Kyle-Ye left a comment

Choose a reason for hiding this comment

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

LGTM (NIT: Update the copyright year)

@j-f1
Copy link
Contributor Author

j-f1 commented Feb 6, 2024

@swift-ci please test

@j-f1 j-f1 merged commit 75bd319 into main Feb 6, 2024
2 checks passed
@j-f1 j-f1 deleted the jed/doxygen-discussion-formatter branch February 6, 2024 17:09
cgrindel-self-hosted-renovate bot referenced this pull request in cgrindel/rules_swift_package_manager Sep 20, 2024
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
|
[apple/swift-markdown](https://redirect.github.com/apple/swift-markdown)
| minor | `0.4.0` -> `0.5.0` |

---

### Release Notes

<details>
<summary>apple/swift-markdown (apple/swift-markdown)</summary>

###
[`v0.5.0`](https://redirect.github.com/swiftlang/swift-markdown/releases/tag/0.5.0):
Swift-Markdown 0.5.0

[Compare
Source](https://redirect.github.com/apple/swift-markdown/compare/0.4.0...0.5.0)

This release is based on the code that shipped into Swift 6.0.

#### What's Changed

- Add link title support for commonmark by
[@&#8203;Kyle-Ye](https://redirect.github.com/Kyle-Ye) in
[https://github.com/swiftlang/swift-markdown/pull/140](https://redirect.github.com/swiftlang/swift-markdown/pull/140)
- Remove dependency on argument-parser by
[@&#8203;ethan-kusters](https://redirect.github.com/ethan-kusters) in
[https://github.com/swiftlang/swift-markdown/pull/149](https://redirect.github.com/swiftlang/swift-markdown/pull/149)
- Fix utf8 decode by
[@&#8203;zunda-pixel](https://redirect.github.com/zunda-pixel) in
[https://github.com/swiftlang/swift-markdown/pull/145](https://redirect.github.com/swiftlang/swift-markdown/pull/145)
- Fix multi line symbol link source range issue by
[@&#8203;Kyle-Ye](https://redirect.github.com/Kyle-Ye) in
[https://github.com/swiftlang/swift-markdown/pull/151](https://redirect.github.com/swiftlang/swift-markdown/pull/151)
- Fix multiline directive without content parsing range issue by
[@&#8203;Kyle-Ye](https://redirect.github.com/Kyle-Ye) in
[https://github.com/swiftlang/swift-markdown/pull/154](https://redirect.github.com/swiftlang/swift-markdown/pull/154)
- build: add a CMake based build by
[@&#8203;compnerd](https://redirect.github.com/compnerd) in
[https://github.com/swiftlang/swift-markdown/pull/141](https://redirect.github.com/swiftlang/swift-markdown/pull/141)
- Add 2024 as an accepted year number by
[@&#8203;Kyle-Ye](https://redirect.github.com/Kyle-Ye) in
[https://github.com/swiftlang/swift-markdown/pull/160](https://redirect.github.com/swiftlang/swift-markdown/pull/160)
- Fix Directive argument name and value ranges on non-first line by
[@&#8203;Kyle-Ye](https://redirect.github.com/Kyle-Ye) in
[https://github.com/swiftlang/swift-markdown/pull/79](https://redirect.github.com/swiftlang/swift-markdown/pull/79)
- Add support for Doxygen discussion/note tags by
[@&#8203;j-f1](https://redirect.github.com/j-f1) in
[https://github.com/swiftlang/swift-markdown/pull/159](https://redirect.github.com/swiftlang/swift-markdown/pull/159)
- Add support for formatting the new Doxygen types using MarkupFormatter
by [@&#8203;j-f1](https://redirect.github.com/j-f1) in
[https://github.com/swiftlang/swift-markdown/pull/163](https://redirect.github.com/swiftlang/swift-markdown/pull/163)
- Support Windows ARM64 builds by
[@&#8203;hjyamauchi](https://redirect.github.com/hjyamauchi) in
[https://github.com/swiftlang/swift-markdown/pull/164](https://redirect.github.com/swiftlang/swift-markdown/pull/164)
- build: silence warning about CMakeLists.txt from SPM by
[@&#8203;compnerd](https://redirect.github.com/compnerd) in
[https://github.com/swiftlang/swift-markdown/pull/167](https://redirect.github.com/swiftlang/swift-markdown/pull/167)

#### New Contributors

- [@&#8203;zunda-pixel](https://redirect.github.com/zunda-pixel) made
their first contribution in
[https://github.com/swiftlang/swift-markdown/pull/145](https://redirect.github.com/swiftlang/swift-markdown/pull/145)
- [@&#8203;j-f1](https://redirect.github.com/j-f1) made their first
contribution in
[https://github.com/swiftlang/swift-markdown/pull/159](https://redirect.github.com/swiftlang/swift-markdown/pull/159)
- [@&#8203;hjyamauchi](https://redirect.github.com/hjyamauchi) made
their first contribution in
[https://github.com/swiftlang/swift-markdown/pull/164](https://redirect.github.com/swiftlang/swift-markdown/pull/164)

**Full Changelog**:
swiftlang/swift-markdown@0.4.0...0.5.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config
help](https://redirect.github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://redirect.github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44OS4xIiwidXBkYXRlZEluVmVyIjoiMzguODkuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: cgrindel-self-hosted-renovate[bot] <139595543+cgrindel-self-hosted-renovate[bot]@users.noreply.github.com>
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.

2 participants