espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-08 03:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[instance] update the documentation for Get<Type> definition (#3569)

Browse Source
This commit is contained in:
Abtin Keshavarzian
2019-02-08 08:43:06 -08:00
committed by Jonathan Hui
parent 3ba1c79910
commit 7494216415
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/common/instance.hpp
+4 -3
View File
@@ -401,9 +401,10 @@ public:
* Note that any `Type` for which the `Get<Type>` is defined MUST be uniquely accessible from the OpenThread
* `Instance` through the member variable property hierarchy.
*
* Specializations of the `Get<Type>()` method are defined in the `instance.cpp`. The specializations are defined
* for any class (type) which can use `GetOwner<Type>` method, i.e., any class that is an owner of a callback
* providing object such as a `Timer`,`Tasklet`, or any sub-class of `OwnerLocator`.
* Specializations of the `Get<Type>()` method are defined in this file after the `Instance` class definition.
* The specializations should be defined for any `Type` that can use `GetOwner<Type>` method, i.e., any
* `Type` that is an owner of a callback providing object such as a `Timer`,`Tasklet`, or any sub-class of
*`OwnerLocator`.
*
* @returns A reference to the `Type` object of the instance.
*