Skip to content

Commit 905c3d8

Browse files
committed
[Gardening] Document Compilation::Result
1 parent d4e76d0 commit 905c3d8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

include/swift/Driver/Compilation.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,20 @@ class Compilation {
8282
struct Result {
8383
/// Set to true if any job exits abnormally (i.e. crashes).
8484
bool hadAbnormalExit;
85+
/// The exit code of this driver process.
8586
int exitCode;
87+
/// The dependency graph built up during the compilation of this module.
88+
///
89+
/// This data is used for cross-module module dependencies.
8690
fine_grained_dependencies::ModuleDepGraph depGraph;
8791

8892
Result(const Result &) = delete;
89-
Result(Result &&) = default;
90-
9193
Result &operator=(const Result &) = delete;
94+
95+
Result(Result &&) = default;
9296
Result &operator=(Result &&) = default;
9397

98+
/// Construct a \c Compilation::Result from just an exit code.
9499
static Result code(int code) {
95100
return Compilation::Result{false, code,
96101
fine_grained_dependencies::ModuleDepGraph()};

0 commit comments

Comments
 (0)