Files
swift-mirror/include/swift/AST/KnownProtocols.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

50 lines
1.4 KiB
C++

//===--- KnownProtocols.h - Working with compiler protocols -----*- 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_AST_KNOWNPROTOCOLS_H
#define SWIFT_AST_KNOWNPROTOCOLS_H
#include "swift/Basic/InlineBitfield.h"
#include "swift/Config.h"
namespace llvm {
class StringRef;
}
namespace swift {
/// The set of known protocols.
enum class KnownProtocolKind : uint8_t {
#define PROTOCOL_WITH_NAME(Id, Name) Id,
#include "swift/AST/KnownProtocols.def"
};
enum : uint8_t {
// This uses a preprocessor trick to count all the protocols. The enum value
// expression below expands to "+1+1+1...". (Note that the first plus
// is parsed as a unary operator.)
#define PROTOCOL_WITH_NAME(Id, Name) +1
/// The number of known protocols.
NumKnownProtocols =
#include "swift/AST/KnownProtocols.def"
};
enum : unsigned { NumKnownProtocolKindBits =
countBitsUsed(static_cast<unsigned>(NumKnownProtocols - 1)) };
/// Retrieve the name of the given known protocol.
llvm::StringRef getProtocolName(KnownProtocolKind kind);
} // end namespace swift
#endif