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

Error: An error was encountered while compiling documentation #2961

Open
shahmishal opened this issue Feb 10, 2025 · 2 comments · May be fixed by #2963
Open

Error: An error was encountered while compiling documentation #2961

shahmishal opened this issue Feb 10, 2025 · 2 comments · May be fixed by #2963
Labels
bug Something isn't working

Comments

@shahmishal
Copy link
Member

Description

CompileDocumentation /Users/ec2-user/jenkins/workspace/oss-swift-pr-test-macos-arm64/swift-syntax/Sources/SwiftBasicFormat/SwiftBasicFormat.docc (in target 'SwiftBasicFormat' from project 'swift-syntax')
    cd /Users/ec2-user/jenkins/workspace/oss-swift-pr-test-macos-arm64/swift-syntax
    /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/docc convert --emit-lmdb-index --fallback-display-name SwiftBasicFormat --fallback-bundle-identifier swift-syntax.SwiftBasicFormat --fallback-bundle-version 0 --output-dir /Users/ec2-user/Library/Developer/Xcode/DerivedData/swift-syntax-doldviwbxbfivxgmqcmdlduayohg/Build/Products/Debug/SwiftBasicFormat.doccarchive --ide-console-output --diagnostics-file /Users/ec2-user/Library/Developer/Xcode/DerivedData/swift-syntax-doldviwbxbfivxgmqcmdlduayohg/Build/Intermediates.noindex/swift-syntax.build/Debug/SwiftBasicFormat.build/SwiftBasicFormat-diagnostics.json --warnings-as-errors /Users/ec2-user/jenkins/workspace/oss-swift-pr-test-macos-arm64/swift-syntax/Sources/SwiftBasicFormat/SwiftBasicFormat.docc --additional-symbol-graph-dir /Users/ec2-user/Library/Developer/Xcode/DerivedData/swift-syntax-doldviwbxbfivxgmqcmdlduayohg/Build/Intermediates.noindex/swift-syntax.build/Debug/SwiftBasicFormat.build/symbol-graph
/Users/ec2-user/jenkins/workspace/oss-swift-pr-test-macos-arm64/swift-syntax/Sources/SwiftBasicFormat/Indenter.swift:24:100: error: Parameter 'indentation' is missing documentation (in target 'SwiftBasicFormat' from project 'swift-syntax')
    note: Document 'indentation' parameter
/Users/ec2-user/jenkins/workspace/oss-swift-pr-test-macos-arm64/swift-syntax/Sources/SwiftBasicFormat/Indenter.swift:24:100: error: Parameter 'indentation' is missing documentation. Document 'indentation' parameter.
/Users/ec2-user/jenkins/workspace/oss-swift-pr-test-macos-arm64/swift-syntax/Sources/SwiftBasicFormat/Indenter.swift:22:7-22:7: fixit: - Parameter indentation: <#parameter description#>
///
Error: An error was encountered while compiling documentation

Steps to Reproduce

Xcode 16.2 + macOS 15.2

  1. on main branch
  2. /usr/bin/xcodebuild docbuild -workspace /Users/ec2-user/jenkins/workspace/oss-swift-pr-test-macos-arm64/swift-syntax -scheme SwiftBasicFormat -destination platform=macOS OTHER_DOCC_FLAGS='--warnings-as-errors'

consoleText-48.txt

@shahmishal shahmishal added the bug Something isn't working label Feb 10, 2025
@ahoppen
Copy link
Member

ahoppen commented Feb 10, 2025

Synced to Apple’s issue tracker as rdar://144510679

shahmishal added a commit that referenced this issue Feb 10, 2025
Xcode 16.2 introduced a large set of the for `missing documentation`

Example: #2961
@ahoppen
Copy link
Member

ahoppen commented Feb 10, 2025

Should be fixed by #2963

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants