Files
swift-mirror/include/swift/Driver/ParseableOutput.h
Adrian Prantl ff63eaea6f Remove \brief commands from doxygen comments.
We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.

Patch produced by

      for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done
2018-12-04 15:45:04 -08:00

54 lines
1.8 KiB
C++

//===--- ParseableOutput.h - Helpers for parseable output -------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
///
/// \file
/// Helpers for emitting the driver's parseable output.
///
//===----------------------------------------------------------------------===//
#ifndef SWIFT_DRIVER_PARSEABLEOUTPUT_H
#define SWIFT_DRIVER_PARSEABLEOUTPUT_H
#include "swift/Basic/LLVM.h"
#include "swift/Basic/TaskQueue.h"
namespace swift {
namespace driver {
class Job;
namespace parseable_output {
/// Emits a "began" message to the given stream.
void emitBeganMessage(raw_ostream &os, const Job &Cmd, int64_t Pid,
sys::TaskProcessInformation ProcInfo);
/// Emits a "finished" message to the given stream.
void emitFinishedMessage(raw_ostream &os, const Job &Cmd, int64_t Pid,
int ExitStatus, StringRef Output,
sys::TaskProcessInformation ProcInfo);
/// Emits a "signalled" message to the given stream.
void emitSignalledMessage(raw_ostream &os, const Job &Cmd, int64_t Pid,
StringRef ErrorMsg, StringRef Output,
Optional<int> Signal,
sys::TaskProcessInformation ProcInfo);
/// Emits a "skipped" message to the given stream.
void emitSkippedMessage(raw_ostream &os, const Job &Cmd);
} // end namespace parseable_output
} // end namespace driver
} // end namespace swift
#endif