Skip to content

Commit dff02ab

Browse files
committed
Document service lifetime
1 parent cb389c0 commit dff02ab

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

clang/include/clang/Tooling/DependencyScanning/DependencyScanningTool.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ struct P1689Rule {
7979
class DependencyScanningTool {
8080
public:
8181
/// Construct a dependency scanning tool.
82+
///
83+
/// @param Service The parent service. Must outlive the tool.
84+
/// @param FS The filesystem for the tool to use. Defaults to the physical FS.
8285
DependencyScanningTool(DependencyScanningService &Service,
8386
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FS =
8487
llvm::vfs::createPhysicalFileSystem());

clang/include/clang/Tooling/DependencyScanning/DependencyScanningWorker.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ class DependencyActionController {
8080
/// using the regular processing run.
8181
class DependencyScanningWorker {
8282
public:
83+
/// Construct a dependency scanning worker.
84+
///
85+
/// @param Service The parent service. Must outlive the worker.
86+
/// @param FS The filesystem for the worker to use.
8387
DependencyScanningWorker(DependencyScanningService &Service,
8488
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FS);
8589

0 commit comments

Comments
 (0)