mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +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
105 lines
2.4 KiB
C++
105 lines
2.4 KiB
C++
//===-- tapi/Version.h - TAPI Version Interface -----------------*- C++ -*-===*\
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
///
|
|
/// \file
|
|
/// Access the TAPI version information.
|
|
/// \since 1.0
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef TAPI_VERSION_H
|
|
#define TAPI_VERSION_H
|
|
|
|
#include <string>
|
|
#include "Defines.h"
|
|
#define TAPI_VERSION 2.0.0
|
|
#define TAPI_VERSION_MAJOR 2
|
|
#define TAPI_VERSION_MINOR 0
|
|
#define TAPI_VERSION_PATCH 0
|
|
|
|
///
|
|
/// \defgroup TAPI_VERSION Version methods
|
|
/// \ingroup TAPI_CPP_API
|
|
///
|
|
/// @{
|
|
///
|
|
|
|
namespace tapi {
|
|
|
|
///
|
|
/// Access to version related information about the TAPI dynamic library.
|
|
/// \since 1.0
|
|
///
|
|
class TAPI_PUBLIC Version {
|
|
public:
|
|
///
|
|
/// \name Version Number Methods
|
|
/// @{
|
|
///
|
|
|
|
///
|
|
/// Get the major version number.
|
|
/// \return The major version number as unsigned integer.
|
|
/// \since 1.0
|
|
///
|
|
static unsigned getMajor() noexcept;
|
|
|
|
///
|
|
/// Get the minor version number.
|
|
/// \return The minor version number as unsigned integer.
|
|
/// \since 1.0
|
|
///
|
|
static unsigned getMinor() noexcept;
|
|
|
|
///
|
|
/// Get the patch version number.
|
|
/// \return The patch version as unsigned integer.
|
|
/// \since 1.0
|
|
///
|
|
static unsigned getPatch() noexcept;
|
|
|
|
///
|
|
/// Get the library version as string.
|
|
/// \return A string with the version number.
|
|
/// \since 1.0
|
|
///
|
|
static std::string getAsString() noexcept;
|
|
|
|
///
|
|
/// Get the full library name and version as string.
|
|
/// \return A string with the program name and version number.
|
|
/// \since 1.0
|
|
///
|
|
static std::string getFullVersionAsString() noexcept;
|
|
|
|
///
|
|
/// Check if the current version is at least the specified version or
|
|
/// greater.
|
|
/// \param[in] major The major version number to compare against.
|
|
/// \param[in] minor The minor version number to compare against.
|
|
/// \param[in] patch The patch version number to compare against.
|
|
/// \return True if the current version number is at least the specified
|
|
/// version or greater.
|
|
/// \since 1.0
|
|
///
|
|
static bool isAtLeast(unsigned major, unsigned minor = 0,
|
|
unsigned patch = 0) noexcept;
|
|
|
|
///
|
|
/// @}
|
|
///
|
|
};
|
|
|
|
} // end tapi namespace.
|
|
|
|
///
|
|
/// @}
|
|
///
|
|
|
|
#endif // TAPI_VERSION_H
|