mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
ff63eaea6f
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
39 lines
1.5 KiB
C++
39 lines
1.5 KiB
C++
//===--- Program.h ----------------------------------------------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_BASIC_PROGRAM_H
|
|
#define SWIFT_BASIC_PROGRAM_H
|
|
|
|
namespace swift {
|
|
|
|
/// This function executes the program using the arguments provided,
|
|
/// preferring to reexecute the current process, if supported.
|
|
///
|
|
/// \param Program Path of the program to be executed
|
|
/// \param args A vector of strings that are passed to the program. The first
|
|
/// element should be the name of the program. The list *must* be terminated by
|
|
/// a null char * entry.
|
|
/// \param env An optional vector of strings to use for the program's
|
|
/// environment. If not provided, the current program's environment will be
|
|
/// used.
|
|
///
|
|
/// \returns Typically, this function will not return, as the current process
|
|
/// will no longer exist, or it will call exit() if the program was successfully
|
|
/// executed. In the event of an error, this function will return a negative
|
|
/// value indicating a failure to execute.
|
|
int ExecuteInPlace(const char *Program, const char **args,
|
|
const char **env = nullptr);
|
|
|
|
} // end namespace swift
|
|
|
|
#endif // SWIFT_BASIC_PROGRAM_H
|