Mesa (master): egl: clarify what _eglInitResource does

[Chia-I Wu]

Module: Mesa
Branch: master
Commit: 4695f64895ed016e8c13b87315fb28fd91a26668
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=4695f64895ed016e8c13b87315fb28fd91a26668

Author: Chia-I Wu <olvaffe at gmail.com>
Date:   Wed Feb 19 13:04:04 2014 +0800

egl: clarify what _eglInitResource does

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

---

 src/egl/main/egldisplay.c |    6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/egl/main/egldisplay.c b/src/egl/main/egldisplay.c
index 97ad865..bed7663 100644
--- 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)