Add "Add documentation" code action to stub out documentation for a function #1206
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@swift-ci please test |
1 similar comment
|
@swift-ci please test |
|
@swift-ci please test Windows |
1 similar comment
|
@swift-ci please test Windows |
|
@swift-ci please test |
|
@swift-ci please test Windows |
|
@swift-ci please test |
|
@swift-ci please test Windows |
ahoppen
reviewed
Apr 26, 2024
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
Sources/SourceKitLSP/Swift/CodeActions/UpdateDocumentation.swift
Outdated
Show resolved
Hide resolved
…toringProvider Rather than only adapt refactoring actions that conform to SyntaxRefactoringProvider, which takes a syntax node and produces a syntax node, adapt to the less-constraining EditRefactoringProvider, which takes a syntax node and produces edits. We can map edits over just as effectively.
…unction
This code action takes an undocumented function declaration like
func refactor(syntax: DeclSyntax, in context: Void) -> DeclSyntax?
and adds stub documentation for the parameters / result / etc., like this:
/// A description
/// - Parameters:
/// - syntax:
/// - context:
///
/// - Returns:
DougGregor
force-pushed
the
add-documentation-code-action
branch
from
9020a9c to
b628738
Compare
|
@swift-ci please test |
|
@swift-ci please test Windows |
|
@swift-ci please test |
|
@swift-ci please test Windows |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This code action takes an undocumented function declaration like
and adds stub documentation for the parameters / result / etc., like this: