Add support for Doxygen discussion/note tags

swiftlang / swift-markdown

A Swift package for parsing, building, editing, and analyzing Markdown documents.

https://swiftpackageindex.com/swiftlang/swift-markdown/documentation/markdown

Apache License 2.0

2.79k stars 191 forks source link

Add support for Doxygen discussion/note tags #159

Closed j-f1 closed 10 months ago

j-f1 commented 10 months ago

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

Summary

This PR adds support for parsing the Doxygen @discussion and @note tags. See also: https://github.com/apple/swift-docc/pull/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.

[x] Added tests
[x] Ran the ./bin/test script and it succeeded
[ ] Updated documentation if necessary — Is there documentation for all the node types?

j-f1 commented 10 months ago

@swift-ci please test

Kyle-Ye commented 10 months ago

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 commented 10 months ago

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 commented 10 months ago

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

j-f1 commented 10 months ago

@swift-ci please test

j-f1 commented 10 months ago

@swift-ci please test