hyung-hwan/qse
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

revised the comment on QSE_XTN()

Browse Source
This commit is contained in:
hyung-hwan
2019-06-25 02:43:45 +00:00
parent 03bdfda578
commit aa5559e400
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
qse/include/qse/macros.h
View File

@ -327,7 +327,13 @@
/** /**
* The QSE_XTN() macro is a convenience macro to retrieve the pointer to * The QSE_XTN() macro is a convenience macro to retrieve the pointer to
* extension space located at the end of an object. The type of the object * extension space located at the end of an object. The type of the object
* should be known in advance for it to work properly. * should be known in advance for it to work properly.
*
* however, most object types provide a specialized function to retreive
* the extension pointer. for instance, if the type is qse_sample_t,
* the corresponding function is qse_sample_getmmgr().
*
* Use the specialized function over QSE_XTN() wherever possible.
*/ */
#define QSE_XTN(obj) ((void*)(obj + 1)) #define QSE_XTN(obj) ((void*)(obj + 1))