[vlc-commits] gl: move Doxygen doc to header file

Rémi Denis-Courmont git at videolan.org
Thu Jan 31 19:00:02 CET 2019


vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Thu Jan 31 19:23:32 2019 +0200| [62a95f410aa80c7c054033d48341482da16ac511] | committer: Rémi Denis-Courmont

gl: move Doxygen doc to header file

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=62a95f410aa80c7c054033d48341482da16ac511
---

 include/vlc_opengl.h      | 13 ++++++++++++-
 src/video_output/opengl.c | 10 ----------
 2 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/include/vlc_opengl.h b/include/vlc_opengl.h
index 57a1e71c3b..f11cdd4c5d 100644
--- a/include/vlc_opengl.h
+++ b/include/vlc_opengl.h
@@ -82,7 +82,18 @@ enum {
     VLC_OPENGL_ES2,
 };
 
-VLC_API vlc_gl_t *vlc_gl_Create(struct vout_window_t *, unsigned, const char *) VLC_USED;
+/**
+ * Creates an OpenGL context (and its underlying surface).
+ *
+ * @note In most cases, you should vlc_gl_MakeCurrent() afterward.
+ *
+ * @param wnd window to use as OpenGL surface
+ * @param flags OpenGL context type
+ * @param name module name (or NULL for auto)
+ * @return a new context, or NULL on failure
+ */
+VLC_API vlc_gl_t *vlc_gl_Create(struct vout_window_t *wnd, unsigned flags,
+                                const char *name) VLC_USED;
 VLC_API void vlc_gl_Release(vlc_gl_t *);
 VLC_API void vlc_gl_Hold(vlc_gl_t *);
 
diff --git a/src/video_output/opengl.c b/src/video_output/opengl.c
index e56dd2b624..a4bb7fc153 100644
--- a/src/video_output/opengl.c
+++ b/src/video_output/opengl.c
@@ -55,16 +55,6 @@ static void vlc_gl_stop(void *func, va_list ap)
     deactivate(gl);
 }
 
-/**
- * Creates an OpenGL context (and its underlying surface).
- *
- * @note In most cases, you should vlc_gl_MakeCurrent() afterward.
- *
- * @param wnd window to use as OpenGL surface
- * @param flags OpenGL context type
- * @param name module name (or NULL for auto)
- * @return a new context, or NULL on failure
- */
 vlc_gl_t *vlc_gl_Create(struct vout_window_t *wnd, unsigned flags,
                         const char *name)
 {



More information about the vlc-commits mailing list