[chore] update Doxygen comments

This commit is contained in:
Nomango 2020-04-16 10:06:36 +08:00
parent b4664deed0
commit 178d54b0d1
3 changed files with 33 additions and 2 deletions

View File

@ -26,6 +26,11 @@ namespace kiwano
KGE_DECLARE_SMART_PTR(Button);
/**
* \addtogroup Component
* @{
*/
/**
* \~chinese
* @brief °´Å¥
@ -109,6 +114,8 @@ private:
Callback mouse_out_callback_;
};
/** @} */
inline void Button::SetClickCallback(const Callback& func)
{
click_callback_ = func;

View File

@ -32,6 +32,16 @@ class Event;
KGE_DECLARE_SMART_PTR(Component);
/**
* \~chinese
* \defgroup Component
*/
/**
* \addtogroup Component
* @{
*/
/// \~chinese
/// @brief 组件列表
typedef IntrusiveList<ComponentPtr> ComponentList;
@ -94,6 +104,8 @@ private:
Actor* actor_;
};
/** @} */
inline bool Component::IsEnable() const
{
return enabled_;

View File

@ -24,6 +24,15 @@
namespace kiwano
{
/**
* \~chinese
* \defgroup Serialization
*/
/**
* \addtogroup Serialization
* @{
*/
/// \~chinese
/// @brief ÐòÁл¯Æ÷
@ -230,7 +239,7 @@ class Serializable
{
public:
/// \~chinese
/// @brief 序列化为字
/// @brief 序列化为字
inline Vector<uint8_t> Serialize() const
{
Vector<uint8_t> data;
@ -240,7 +249,7 @@ public:
}
/// \~chinese
/// @brief 从字串反序列化
/// @brief 从字串反序列化
inline void Deserialize(const Vector<uint8_t>& data)
{
ByteDeserializer deserializer(data);
@ -438,4 +447,7 @@ inline Deserializer& operator>>(Deserializer& deserializer, math::TransformT<flo
return deserializer >> transform.position >> transform.rotation >> transform.scale >> transform.skew;
}
/** @} */
} // namespace kiwano