Fixed Doxygen Comment Style
authorEdward Slavin <eslavin@nvidia.com>
Mon, 11 Dec 2023 12:30:30 +0000 (07:30 -0500)
committerEdward Slavin <eslavin@nvidia.com>
Wed, 13 Dec 2023 22:14:19 +0000 (17:14 -0500)
- Adjusted doxygen style in unicode character classes from @ to \

pxr/base/tf/unicode/unicodeCharacterClasses.template.cpp
pxr/base/tf/unicodeCharacterClasses.cpp
pxr/base/tf/unicodeCharacterClasses.h

index e16e7e454d62106c8ce687a4431052b25c292261..c538fdacb281896abf9888bd9ddd79fa3ce358e1 100644 (file)
@@ -29,7 +29,7 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-/// @brief 
+/// \brief 
 /// Provides static initialization of the character class data
 /// contained within the XID_Start set of Unicode character classes.
 ///
@@ -42,7 +42,7 @@ public:
     std::vector<std::pair<uint32_t, uint32_t>> ranges;
 };
 
-/// @brief 
+/// \brief 
 /// Provides static initialization of the character class data
 /// contained within the XID_Continue set of Unicode character classes.
 ///
index 45f46f54b069ffcdcd1d0936c9cb7e42f3647cb6..7e4c3d6fa884e81c6ffb53e5a3141c0e0f0661e8 100644 (file)
@@ -29,7 +29,7 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-/// @brief 
+/// \brief 
 /// Provides static initialization of the character class data
 /// contained within the XID_Start set of Unicode character classes.
 ///
@@ -42,7 +42,7 @@ public:
     std::vector<std::pair<uint32_t, uint32_t>> ranges;
 };
 
-/// @brief 
+/// \brief 
 /// Provides static initialization of the character class data
 /// contained within the XID_Continue set of Unicode character classes.
 ///
index 3b637caf230eb3c77b0b0225c3c05473071c181c..3328ea9a0a3ab578ea4d5596e56b84889acd7e3f 100644 (file)
@@ -36,7 +36,7 @@ PXR_NAMESPACE_OPEN_SCOPE
 // but we need the flags to be contiguous
 constexpr uint32_t TF_MAX_CODE_POINT = 1114112;
 
-/// @brief 
+/// \brief 
 /// Provides static initialization of the whether a Unicode code
 /// point is contained with the XID_Start set of Unicode character
 /// classes.
@@ -47,10 +47,10 @@ public:
 
     TfUnicodeXidStartFlagData();
 
-    /// @brief Determines whether the given code point is contained within
+    /// \brief Determines whether the given code point is contained within
     /// the XID_Start character class.
-    /// @param codePoint The Unicode code point to determine inclusion for.
-    /// @return true if the given codePoint is in the XID_Start character
+    /// \param codePoint The Unicode code point to determine inclusion for.
+    /// \return true if the given codePoint is in the XID_Start character
     /// class, false otherwise.
     bool IsXidStartCodePoint(uint32_t codePoint) const;
 
@@ -59,7 +59,7 @@ private:
     std::bitset<TF_MAX_CODE_POINT> _flags;
 };
 
-/// @brief 
+/// \brief 
 /// Provides static initialization of the whether a Unicode code
 /// point is contained with the XID_Continue set of Unicode character
 /// classes.
@@ -70,10 +70,10 @@ public:
 
     TfUnicodeXidContinueFlagData();
 
-    /// @brief Determines whether the given code point is contained within
+    /// \brief Determines whether the given code point is contained within
     /// the XID_Continue character class.
-    /// @param codePoint The Unicode code point to determine inclusion for.
-    /// @return true if the given codePoint is in the XID_Continue 
+    /// \param codePoint The Unicode code point to determine inclusion for.
+    /// \return true if the given codePoint is in the XID_Continue 
     /// character class false otherwise.
     bool IsXidContinueCodePoint(uint32_t codePoint) const;
 
@@ -82,13 +82,13 @@ private:
     std::bitset<TF_MAX_CODE_POINT> _flags;
 };
 
-/// @brief Retreives character class data for XID_Start.
-/// @return An object which can be used to interrogate whether a code point
+/// \brief Retreives character class data for XID_Start.
+/// \return An object which can be used to interrogate whether a code point
 /// is contained within the XID_Start character class.
 const TfUnicodeXidStartFlagData& TfUnicodeGetXidStartFlagData();
 
-/// @brief Retreives character class data for XID_Continue.
-/// @return An object which can be used to interrogate whether a code point
+/// \brief Retreives character class data for XID_Continue.
+/// \return An object which can be used to interrogate whether a code point
 /// is contained within the XID_Continue character class.
 const TfUnicodeXidContinueFlagData& TfUnicodeGetXidContinueFlagData();