Skip to content

Commit 1b01f21

Browse files
committed
[Gardening] Add a spot of documentation about withReferenceDependencies
1 parent 76cd4bf commit 1b01f21

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

include/swift/AST/FineGrainedDependencies.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,10 @@ class BiIndexedTwoStageMap {
346346
// MARK: Start of fine-grained-dependency-specific code
347347
//==============================================================================
348348

349+
/// Uses the provided module or source file to construct a dependency graph,
350+
/// which is provided back to the caller in the continuation callback.
351+
///
352+
/// \Note The returned graph should not be escaped from the callback.
349353
bool withReferenceDependencies(
350354
llvm::PointerUnion<ModuleDecl *, SourceFile *> MSF,
351355
const DependencyTracker &depTracker, StringRef outputPath,

0 commit comments

Comments
 (0)