summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2017-01-27 18:12:05 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2017-02-03 11:13:30 +0000
commit6af57b07459742b90ef7471733bd090a4580fe61 (patch)
tree93ff8fdcd40bdd2113206fce3961fd41e5237c71 /include
parent59d9c2d83db722599d612f4339d9d8405f0c13e7 (diff)
downloadlibepoxy-6af57b07459742b90ef7471733bd090a4580fe61.tar.gz
Write the API reference
Now that we have Doxygen generating it, we should fill out the API reference for Epoxy.
Diffstat (limited to 'include')
-rw-r--r--include/epoxy/egl.h2
-rw-r--r--include/epoxy/gl.h2
-rw-r--r--include/epoxy/glx.h2
3 files changed, 6 insertions, 0 deletions
diff --git a/include/epoxy/egl.h b/include/epoxy/egl.h
index 67b22ce..2550acc 100644
--- a/include/epoxy/egl.h
+++ b/include/epoxy/egl.h
@@ -25,6 +25,8 @@
*
* Provides an implementation of an EGL dispatch layer using global
* function pointers
+ *
+ * You should include `<epoxy/egl.h>` instead of `<EGL/egl.h>`.
*/
#ifndef EPOXY_EGL_H
diff --git a/include/epoxy/gl.h b/include/epoxy/gl.h
index c3a7437..078ecee 100644
--- a/include/epoxy/gl.h
+++ b/include/epoxy/gl.h
@@ -25,6 +25,8 @@
*
* Provides an implementation of a GL dispatch layer using either
* global function pointers or a hidden vtable.
+ *
+ * You should include `<epoxy/gl.h>` instead of `<GL/gl.h>` and `<GL/glext.h>`.
*/
#ifndef EPOXY_GL_H
diff --git a/include/epoxy/glx.h b/include/epoxy/glx.h
index f5214f1..c911b7c 100644
--- a/include/epoxy/glx.h
+++ b/include/epoxy/glx.h
@@ -25,6 +25,8 @@
*
* Provides an implementation of a GLX dispatch layer using global
* function pointers.
+ *
+ * You should include `<epoxy/glx.h>` instead of `<GL/glx.h>`.
*/
#ifndef EPOXY_GLX_H