egl: clarify what _eglInitResource does

It is a helper called from the initializers of its subclasses.
2014-02-19 13:04:04 +08:00
parent dc97e54d97
commit 4695f64895
1 changed files with 5 additions and 1 deletions
@@ -375,7 +375,11 @@ _eglCheckResource(void *res, _EGLResourceType type, _EGLDisplay *dpy)


 /**
- * Initialize a display resource.
+ * Initialize a display resource.  The size of the subclass object is
+ * specified.
+ *
+ * This is supposed to be called from the initializers of subclasses, such as
+ * _eglInitContext or _eglInitSurface.
 */
 void
 _eglInitResource(_EGLResource *res, EGLint size, _EGLDisplay *dpy)