From 80321b8cc231e518445ecf1b5a7b14d997c21d09 Mon Sep 17 00:00:00 2001 From: Dylan McKay Date: Sun, 15 Nov 2015 05:43:11 +0000 Subject: [PATCH] NFC: Document MSVC getters on Triple Summary: Document the differences between the isKnownWindowsMSVC() and isWindowsMSVC() methods on Triple. Also removed the '\brief' Doxygen annotations - now that 'AUTOBRIEF' is set to on, they are unnecessary. Subscribers: jfb, tberghammer, danalbert, srhines, dschuff Differential Revision: http://reviews.llvm.org/D14110 llvm-svn: 253159 --- llvm/include/llvm/ADT/Triple.h | 40 ++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/llvm/include/llvm/ADT/Triple.h b/llvm/include/llvm/ADT/Triple.h index ad9fe0603647..e50cec1f5e80 100644 --- a/llvm/include/llvm/ADT/Triple.h +++ b/llvm/include/llvm/ADT/Triple.h @@ -213,7 +213,7 @@ public: /// @name Constructors /// @{ - /// \brief Default constructor is the same as an empty string and leaves all + /// Default constructor is the same as an empty string and leaves all /// triple fields unknown. Triple() : Data(), Arch(), Vendor(), OS(), Environment(), ObjectFormat() {} @@ -239,7 +239,7 @@ public: /// common case in which otherwise valid components are in the wrong order. static std::string normalize(StringRef Str); - /// \brief Return the normalized form of this triple's string. + /// Return the normalized form of this triple's string. std::string normalize() const { return normalize(Data); } /// @} @@ -267,7 +267,7 @@ public: /// getEnvironment - Get the parsed environment type of this triple. EnvironmentType getEnvironment() const { return Environment; } - /// \brief Parse the version number from the OS name component of the + /// Parse the version number from the OS name component of the /// triple, if present. /// /// For example, "fooos1.2.3" would return (1, 2, 3). @@ -344,7 +344,7 @@ public: /// @name Convenience Predicates /// @{ - /// \brief Test whether the architecture is 64-bit + /// Test whether the architecture is 64-bit /// /// Note that this tests for 64-bit pointer width, and nothing else. Note /// that we intentionally expose only three predicates, 64-bit, 32-bit, and @@ -353,12 +353,12 @@ public: /// system is provided. bool isArch64Bit() const; - /// \brief Test whether the architecture is 32-bit + /// Test whether the architecture is 32-bit /// /// Note that this tests for 32-bit pointer width, and nothing else. bool isArch32Bit() const; - /// \brief Test whether the architecture is 16-bit + /// Test whether the architecture is 16-bit /// /// Note that this tests for 16-bit pointer width, and nothing else. bool isArch16Bit() const; @@ -458,12 +458,14 @@ public: return getOS() == Triple::ELFIAMCU; } + /// Checks if the environment could be MSVC. bool isWindowsMSVCEnvironment() const { return getOS() == Triple::Win32 && (getEnvironment() == Triple::UnknownEnvironment || getEnvironment() == Triple::MSVC); } + /// Checks if the environment is MSVC. bool isKnownWindowsMSVCEnvironment() const { return getOS() == Triple::Win32 && getEnvironment() == Triple::MSVC; } @@ -484,61 +486,61 @@ public: return getOS() == Triple::Win32 && getEnvironment() == Triple::GNU; } - /// \brief Tests for either Cygwin or MinGW OS + /// Tests for either Cygwin or MinGW OS bool isOSCygMing() const { return isWindowsCygwinEnvironment() || isWindowsGNUEnvironment(); } - /// \brief Is this a "Windows" OS targeting a "MSVCRT.dll" environment. + /// Is this a "Windows" OS targeting a "MSVCRT.dll" environment. bool isOSMSVCRT() const { return isWindowsMSVCEnvironment() || isWindowsGNUEnvironment() || isWindowsItaniumEnvironment(); } - /// \brief Tests whether the OS is Windows. + /// Tests whether the OS is Windows. bool isOSWindows() const { return getOS() == Triple::Win32; } - /// \brief Tests whether the OS is NaCl (Native Client) + /// Tests whether the OS is NaCl (Native Client) bool isOSNaCl() const { return getOS() == Triple::NaCl; } - /// \brief Tests whether the OS is Linux. + /// Tests whether the OS is Linux. bool isOSLinux() const { return getOS() == Triple::Linux; } - /// \brief Tests whether the OS uses the ELF binary format. + /// Tests whether the OS uses the ELF binary format. bool isOSBinFormatELF() const { return getObjectFormat() == Triple::ELF; } - /// \brief Tests whether the OS uses the COFF binary format. + /// Tests whether the OS uses the COFF binary format. bool isOSBinFormatCOFF() const { return getObjectFormat() == Triple::COFF; } - /// \brief Tests whether the environment is MachO. + /// Tests whether the environment is MachO. bool isOSBinFormatMachO() const { return getObjectFormat() == Triple::MachO; } - /// \brief Tests whether the target is the PS4 CPU + /// Tests whether the target is the PS4 CPU bool isPS4CPU() const { return getArch() == Triple::x86_64 && getVendor() == Triple::SCEI && getOS() == Triple::PS4; } - /// \brief Tests whether the target is the PS4 platform + /// Tests whether the target is the PS4 platform bool isPS4() const { return getVendor() == Triple::SCEI && getOS() == Triple::PS4; } - /// \brief Tests whether the target is Android + /// Tests whether the target is Android bool isAndroid() const { return getEnvironment() == Triple::Android; } /// @} @@ -591,7 +593,7 @@ public: /// @name Helpers to build variants of a particular triple. /// @{ - /// \brief Form a triple with a 32-bit variant of the current architecture. + /// Form a triple with a 32-bit variant of the current architecture. /// /// This can be used to move across "families" of architectures where useful. /// @@ -599,7 +601,7 @@ public: /// architecture if no such variant can be found. llvm::Triple get32BitArchVariant() const; - /// \brief Form a triple with a 64-bit variant of the current architecture. + /// Form a triple with a 64-bit variant of the current architecture. /// /// This can be used to move across "families" of architectures where useful. ///