Skip to content

[6.2] parse Doxygen commands if a previous directive is being truncated #224

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

Merged
merged 2 commits into from
Apr 25, 2025
Merged

[6.2] parse Doxygen commands if a previous directive is being truncated #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a974008
add check-source support for 2025 and ignore Tools/.build
QuietMisdreavus Apr 21, 2025
dc80a97
parse doxygen commands if a previous block directive is truncated
QuietMisdreavus Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions Sources/Markdown/Parser/BlockDirectiveParser.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift.org open source project

Copyright (c) 2021-2023 Apple Inc. and the Swift project authors
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
Expand Down Expand Up @@ -799,9 +799,7 @@ struct ParseContainerStack {

guard !isInBlockDirective else { return false }

if case .blockDirective = top {
return false
} else if case .lineRun(_, isInCodeFence: let codeFence) = top {
if case .lineRun(_, isInCodeFence: let codeFence) = top {
return !codeFence
} else {
return true
Expand Down
2 changes: 1 addition & 1 deletion Tests/MarkdownTests/Parsing/BlockDirectiveParserTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift.org open source project

Copyright (c) 2021-2023 Apple Inc. and the Swift project authors
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
Expand Down
30 changes: 29 additions & 1 deletion Tests/MarkdownTests/Parsing/DoxygenCommandParserTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift.org open source project

Copyright (c) 2023 Apple Inc. and the Swift project authors
Copyright (c) 2023-2025 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
Expand Down Expand Up @@ -436,4 +436,32 @@ class DoxygenCommandParserTests: XCTestCase {
"""#
XCTAssertEqual(document.debugDescription(), expectedDump)
}

func testRunOnDirectivesAllowDoxygenParsing() {
let source = #"""
@method doSomethingWithNumber:
@abstract Some brief description of this method
@param number Some description of the "number" parameter
@return Some description of the return value
@discussion Some longer discussion for this method
"""#

let document = Document(parsing: source, options: parseOptions)

let expectedDump = #"""
Document
├─ BlockDirective name: "method"
├─ BlockDirective name: "abstract"
├─ DoxygenParameter parameter: number
│ └─ Paragraph
│ └─ Text "Some description of the “number” parameter"
├─ DoxygenReturns
│ └─ Paragraph
│ └─ Text "Some description of the return value"
└─ DoxygenDiscussion
└─ Paragraph
└─ Text "Some longer discussion for this method"
"""#
XCTAssertEqual(document.debugDescription(), expectedDump)
}
}
5 changes: 3 additions & 2 deletions bin/check-source
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
# Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
Expand All @@ -18,7 +18,7 @@ here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

function replace_acceptable_years() {
# this needs to replace all acceptable forms with 'YEARS'
sed -e 's/20[12][78901234]-20[12][8901234]/YEARS/' -e 's/20[12][8901234]/YEARS/'
sed -e 's/20[12][789012345]-20[12][89012345]/YEARS/' -e 's/20[12][89012345]/YEARS/'
}

printf "=> Checking for unacceptable language… "
Expand Down Expand Up @@ -151,6 +151,7 @@ EOF
cd "$here/.."
find . \
\( \! -path './.build/*' -a \
\! -path './Tools/.build/*' -a \
\! -name '.' -a \
\( "${matching_files[@]}" \) -a \
\( \! \( "${exceptions[@]}" \) \) \) | while read line; do
Expand Down