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 Doxygen discussion/note tags #159

Merged
merged 6 commits into from
Feb 1, 2024
Merged

Add support for Doxygen discussion/note tags #159

merged 6 commits into from
Feb 1, 2024

Conversation

j-f1
Copy link
Contributor

@j-f1 j-f1 commented Jan 12, 2024 •
edited
Loading

Bug/issue #, if applicable: Related to rdar://116077012

Summary

This PR adds support for parsing the Doxygen @discussion and @note tags. See also: swiftlang/swift-docc#798

Dependencies

None; the PR to swift-docc depends on this PR.

Testing

I’ve added basic automated tests, but am open to adding more!

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 — Is there documentation for all the node types?

@j-f1 j-f1 mentioned this pull request Jan 12, 2024
Merged
5 tasks
@j-f1
Copy link
Contributor Author

j-f1 commented Jan 12, 2024

@swift-ci please test

@Kyle-Ye Kyle-Ye mentioned this pull request Jan 28, 2024
Merged
3 tasks
@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Jan 28, 2024

  • The “Checking license headers” check failed but I don’t understand why. It looks like my headers are well-formed? It wants me to change them to say “Copyright (c) YEARS”

This issue should be fixed by #160. After it gets merged, you can rebase/merge main to give it a try.

@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Jan 29, 2024

I remember we used to check ./bin/test result on CI. But it does not now.

It means we can merge PR when ./bin/test result fails.

cc @franklinsch @shahmishal

@Kyle-Ye Kyle-Ye closed this in #160 Jan 29, 2024
@Kyle-Ye Kyle-Ye reopened this Jan 29, 2024
@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Jan 29, 2024

GitHub accidentally closes this after #160 gets merged. Reopened it. Sorry for the inconvenience.

Kyle-Ye
Kyle-Ye requested changes Jan 29, 2024
View reviewed changes
Copy link
Contributor

@Kyle-Ye Kyle-Ye 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.

IMO, you need to update the CMakeLists.txt file to add the files explicitly.

https://github.com/apple/swift-markdown/blob/main/Sources/Markdown/CMakeLists.txt

See discussion about file lists and folder blob here #141 (comment)

Also what will happen if someone accidentally forgot to update the CMakeLists.txt file? Should we add a CI to check this?
cc @compnerd

@j-f1
Copy link
Contributor Author

j-f1 commented Jan 29, 2024

@swift-ci please test

@Kyle-Ye Kyle-Ye self-requested a review February 1, 2024 13:20
@j-f1
Copy link
Contributor Author

j-f1 commented Feb 1, 2024

@swift-ci please test

@j-f1 j-f1 merged commit cfe8c84 into main Feb 1, 2024
2 checks passed
@j-f1 j-f1 deleted the jed/doxygen-discussion-note branch February 1, 2024 17:30
@j-f1 j-f1 mentioned this pull request Feb 6, 2024
Merged
3 tasks
cgrindel-self-hosted-renovate bot referenced this pull request in cgrindel/rules_swift_package_manager Sep 20, 2024
@cgrindel-self-hosted-renovate
chore(deps): update dependency apple/swift-markdown to v0.5.0 (#1244)
e552bdb 
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
Reviewers

@Kyle-Ye Kyle-Ye Kyle-Ye approved these changes

@QuietMisdreavus QuietMisdreavus Awaiting requested review from QuietMisdreavus

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

Successfully merging this pull request may close these issues.
2 participants
@j-f1 @Kyle-Ye