egl: clarify what _eglInitResource does

It is a helper called from the initializers of its subclasses.

diff --git a/src/egl/main/egldisplay.c b/src/egl/main/egldisplay.c
index 97ad8652f5a33ff05ea29b9708f5ef89bd72d8e9..bed7663efc5a5ff43b3acfbeeb9153028da16c72 100644 (file)
--- a/src/egl/main/egldisplay.c
+++ b/src/egl/main/egldisplay.c
@@ -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)