From af8187b9ae9493fe5b3a53812bf2a68cbac55ab7 Mon Sep 17 00:00:00 2001 From: lianliguang Date: Wed, 23 Mar 2022 10:01:03 +0800 Subject: [PATCH] fix docs error --- mindspore/core/ir/named.h | 16 +++++------ mindspore/core/ir/scalar.h | 54 +++++++++++++++++++------------------- 2 files changed, 35 insertions(+), 35 deletions(-) diff --git a/mindspore/core/ir/named.h b/mindspore/core/ir/named.h index 9e902c3ea20..84302c03548 100644 --- a/mindspore/core/ir/named.h +++ b/mindspore/core/ir/named.h @@ -24,10 +24,10 @@ #include "ir/anf.h" namespace mindspore { -/// \beief Named defines an abstract class that records the name and hash_id. +/// \brief Named defines an abstract class that records the name and hash_id. class MS_CORE_API Named : public Value { public: - /// \beief The constructor for Named. + /// \brief The constructor for Named. /// /// \param[in] name The name of object. explicit Named(const std::string &name) : name_(name) { hash_id_ = std::hash{}(name); } @@ -111,10 +111,10 @@ struct MS_CORE_API NamedEqual { return *t1 == *t2; } }; -/// \beief None defines interface for none data. +/// \brief None defines interface for none data. class MS_CORE_API None final : public Named { public: - /// \beief The default constructor for None. + /// \brief The default constructor for None. None() : Named("None") {} /// \brief The destructor of None. ~None() override = default; @@ -123,10 +123,10 @@ class MS_CORE_API None final : public Named { }; GVAR_DEF(NamedPtr, kNone, std::make_shared()); -/// \beief Null defines interface for null data. +/// \brief Null defines interface for null data. class MS_CORE_API Null final : public Named { public: - /// \beief The default constructor for Null. + /// \brief The default constructor for Null. Null() : Named("Null") {} /// \brief The destructor of Null. ~Null() override = default; @@ -135,10 +135,10 @@ class MS_CORE_API Null final : public Named { }; GVAR_DEF(NamedPtr, kNull, std::make_shared()); -/// \beief Ellipsis defines interface for ... data. +/// \brief Ellipsis defines interface for ... data. class MS_CORE_API Ellipsis final : public Named { public: - /// \beief The default constructor for Ellipsis. + /// \brief The default constructor for Ellipsis. Ellipsis() : Named("Ellipsis") {} /// \brief The destructor of Ellipsis. ~Ellipsis() override = default; diff --git a/mindspore/core/ir/scalar.h b/mindspore/core/ir/scalar.h index 79c0ef7b696..c47891ecb32 100644 --- a/mindspore/core/ir/scalar.h +++ b/mindspore/core/ir/scalar.h @@ -35,10 +35,10 @@ using std::fabs; namespace mindspore { -/// \beief Scalar defines interface for scalar data. +/// \brief Scalar defines interface for scalar data. class MS_CORE_API Scalar : public Value { public: - /// \beief The default constructor for Scalar. + /// \brief The default constructor for Scalar. Scalar() = default; /// \brief The constructor for Scalar. /// @@ -62,7 +62,7 @@ class MS_CORE_API Scalar : public Value { }; using ScalarPtr = std::shared_ptr; -/// \beief BoolImm defines interface for bool data. +/// \brief BoolImm defines interface for bool data. class MS_CORE_API BoolImm final : public Scalar { public: /// \brief The constructor of BoolImm. @@ -105,10 +105,10 @@ class MS_CORE_API BoolImm final : public Scalar { using BoolImmPtr = std::shared_ptr; IMM_TRAITS(BoolImmPtr, bool) -/// \beief IntegerImm defines interface for integer data. +/// \brief IntegerImm defines interface for integer data. class MS_CORE_API IntegerImm : public Scalar { public: - /// \beief The default constructor for IntegerImm. + /// \brief The default constructor for IntegerImm. IntegerImm() = default; /// \brief The constructor for IntegerImm. /// @@ -119,10 +119,10 @@ class MS_CORE_API IntegerImm : public Scalar { MS_DECLARE_PARENT(IntegerImm, Scalar) }; -/// \beief Int8Imm defines interface for int8 data. +/// \brief Int8Imm defines interface for int8 data. class MS_CORE_API Int8Imm final : public IntegerImm { public: - /// \beief The default constructor for Int8Imm. + /// \brief The default constructor for Int8Imm. Int8Imm() : IntegerImm(kInt8), v_(0) {} /// \brief The constructor for Int8Imm. /// @@ -157,10 +157,10 @@ class MS_CORE_API Int8Imm final : public IntegerImm { }; using Int8ImmPtr = std::shared_ptr; IMM_TRAITS(Int8ImmPtr, int8_t) -/// \beief Int16Imm defines interface for int16 data. +/// \brief Int16Imm defines interface for int16 data. class MS_CORE_API Int16Imm final : public IntegerImm { public: - /// \beief The default constructor for Int16Imm. + /// \brief The default constructor for Int16Imm. Int16Imm() : IntegerImm(kInt16), v_(0) {} /// \brief The constructor for Int16Imm. /// @@ -196,10 +196,10 @@ class MS_CORE_API Int16Imm final : public IntegerImm { using Int16ImmPtr = std::shared_ptr; IMM_TRAITS(Int16ImmPtr, int16_t) -/// \beief Int32Imm defines interface for int32 data. +/// \brief Int32Imm defines interface for int32 data. class MS_CORE_API Int32Imm final : public IntegerImm { public: - /// \beief The default constructor for Int32Imm. + /// \brief The default constructor for Int32Imm. Int32Imm() : IntegerImm(kInt32), v_(0) {} /// \brief The constructor for Int32Imm. /// @@ -235,10 +235,10 @@ class MS_CORE_API Int32Imm final : public IntegerImm { using Int32ImmPtr = std::shared_ptr; IMM_TRAITS(Int32ImmPtr, int32_t) -/// \beief Int64Imm defines interface for int64 data. +/// \brief Int64Imm defines interface for int64 data. class MS_CORE_API Int64Imm final : public IntegerImm { public: - /// \beief The default constructor for Int64Imm. + /// \brief The default constructor for Int64Imm. Int64Imm() : IntegerImm(kInt64), v_(0) {} /// \brief The constructor for Int64Imm. /// @@ -273,10 +273,10 @@ class MS_CORE_API Int64Imm final : public IntegerImm { }; using Int64ImmPtr = std::shared_ptr; IMM_TRAITS(Int64ImmPtr, int64_t) -/// \beief UInt8Imm defines interface for uint8 data. +/// \brief UInt8Imm defines interface for uint8 data. class MS_CORE_API UInt8Imm final : public IntegerImm { public: - /// \beief The default constructor for UInt8Imm. + /// \brief The default constructor for UInt8Imm. UInt8Imm() : IntegerImm(kUInt8), v_(0) {} /// \brief The constructor for UInt8Imm. /// @@ -314,10 +314,10 @@ class MS_CORE_API UInt8Imm final : public IntegerImm { using UInt8ImmPtr = std::shared_ptr; IMM_TRAITS(UInt8ImmPtr, uint8_t); -/// \beief UInt16Imm defines interface for uint16 data. +/// \brief UInt16Imm defines interface for uint16 data. class MS_CORE_API UInt16Imm final : public IntegerImm { public: - /// \beief The default constructor for UInt16Imm. + /// \brief The default constructor for UInt16Imm. UInt16Imm() : IntegerImm(kUInt16), v_(0) {} /// \brief The constructor for UInt16Imm. /// @@ -355,10 +355,10 @@ class MS_CORE_API UInt16Imm final : public IntegerImm { using UInt16ImmPtr = std::shared_ptr; IMM_TRAITS(UInt16ImmPtr, uint16_t); -/// \beief UInt32Imm defines interface for uint32 data. +/// \brief UInt32Imm defines interface for uint32 data. class MS_CORE_API UInt32Imm final : public IntegerImm { public: - /// \beief The default constructor for UInt32Imm. + /// \brief The default constructor for UInt32Imm. UInt32Imm() : IntegerImm(kUInt32), v_(0) {} /// \brief The constructor for UInt32Imm. /// @@ -395,10 +395,10 @@ class MS_CORE_API UInt32Imm final : public IntegerImm { }; using UInt32ImmPtr = std::shared_ptr; IMM_TRAITS(UInt32ImmPtr, uint32_t); -/// \beief UInt64Imm defines interface for uint64 data. +/// \brief UInt64Imm defines interface for uint64 data. class MS_CORE_API UInt64Imm final : public IntegerImm { public: - /// \beief The default constructor for UInt64Imm. + /// \brief The default constructor for UInt64Imm. UInt64Imm() : IntegerImm(kUInt64), v_(0) {} /// \brief The constructor for UInt64Imm. /// @@ -441,10 +441,10 @@ using SizetImmPtr = std::shared_ptr; IMM_TRAITS(SizetImmPtr, size_t); #endif -/// \beief FloatImm defines interface for float data. +/// \brief FloatImm defines interface for float data. class MS_CORE_API FloatImm : public Scalar { public: - /// \beief The default constructor for FloatImm. + /// \brief The default constructor for FloatImm. FloatImm() = default; /// \brief The constructor for FloatImm. /// @@ -456,10 +456,10 @@ class MS_CORE_API FloatImm : public Scalar { }; using FloatImmPtr = std::shared_ptr; -/// \beief FP32Imm defines interface for float32 data. +/// \brief FP32Imm defines interface for float32 data. class MS_CORE_API FP32Imm final : public FloatImm { public: - /// \beief The default constructor for FP32Imm. + /// \brief The default constructor for FP32Imm. FP32Imm() : FloatImm(kFloat32), v_(0.0) {} /// \brief The constructor for FP32Imm. /// @@ -494,10 +494,10 @@ class MS_CORE_API FP32Imm final : public FloatImm { }; using FP32ImmPtr = std::shared_ptr; IMM_TRAITS(FP32ImmPtr, float) -/// \beief FP64Imm defines interface for float64 data. +/// \brief FP64Imm defines interface for float64 data. class MS_CORE_API FP64Imm final : public FloatImm { public: - /// \beief The default constructor for FP64Imm. + /// \brief The default constructor for FP64Imm. FP64Imm() : FloatImm(kFloat64), v_(0.0) {} /// \brief The constructor for FP64Imm. ///