Merge pull request #2856 from erslavin/unicode_character_classes_doxygen

Unicode character classes doxygen

(Internal change: 2309007)

diff --cc pxr/base/tf/unicodeCharacterClasses.h
index 15d3f005ea085d2c7c853468e5c105642dba6669,3328ea9a0a3ab578ea4d5596e56b84889acd7e3f..ad476da79af30952180040461e539adfe3f564a8
--- 1/pxr/base/tf/unicodeCharacterClasses.h
--- 2/pxr/base/tf/unicodeCharacterClasses.h
+++ b/pxr/base/tf/unicodeCharacterClasses.h
@@@ -47,14 -47,12 +47,14 @@@ 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;
 +    inline bool IsXidStartCodePoint(uint32_t codePoint) const {
 +        return (codePoint < TF_MAX_CODE_POINT) ? _flags[codePoint] : false;
 +    }
  
  private:
  
@@@ -72,27 -70,25 +72,27 @@@ 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;
 +    inline bool IsXidContinueCodePoint(uint32_t codePoint) const {
 +        return (codePoint < TF_MAX_CODE_POINT) ? _flags[codePoint] : false;
 +    }
  
  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.
++/// \brief Retrieves 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.
++/// \brief Retrieves 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();