[vlc-devel] [PATCH 13/19] opengl: move documentation to vlc_opengl.h

[Kartik Ohri]

From: rustyc <amcap1712 at gmail.com>

Move documentation for VLC API methods
vlc_gl_surface_CheckSize from
src/video_output/opengl.c to include/vlc_opengl.h.
---
 include/vlc_opengl.h      | 9 +++++++++
 src/video_output/opengl.c | 8 --------
 2 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/include/vlc_opengl.h b/include/vlc_opengl.h
index 79e165e72b..14b39cdcc7 100644
--- a/include/vlc_opengl.h
+++ b/include/vlc_opengl.h
@@ -128,6 +128,15 @@ static inline void *vlc_gl_GetProcAddress(vlc_gl_t *gl, const char *name)
 VLC_API vlc_gl_t *vlc_gl_surface_Create(vlc_object_t *,
                                         const struct vout_window_cfg_t *,
                                         struct vout_window_t **) VLC_USED;
+
+/**
+ * Checks if the dimensions of the surface used by the OpenGL context have
+ * changed (since the previous call), and  the OpenGL viewport should be
+ * updated.
+ * \return true if at least one dimension has changed, false otherwise
+ * \warning This function is intrinsically race-prone.
+ * The dimensions can change asynchronously.
+ */
 VLC_API bool vlc_gl_surface_CheckSize(vlc_gl_t *, unsigned *w, unsigned *h);
 VLC_API void vlc_gl_surface_Destroy(vlc_gl_t *);
 
diff --git a/src/video_output/opengl.c b/src/video_output/opengl.c
index e5aa450888..825d655303 100644
--- a/src/video_output/opengl.c
+++ b/src/video_output/opengl.c
@@ -191,14 +191,6 @@ error:
     return NULL;
 }
 
-/**
- * Checks if the dimensions of the surface used by the OpenGL context have
- * changed (since the previous call), and  the OpenGL viewport should be
- * updated.
- * \return true if at least one dimension has changed, false otherwise
- * \warning This function is intrinsically race-prone.
- * The dimensions can change asynchronously.
- */
 bool vlc_gl_surface_CheckSize(vlc_gl_t *gl, unsigned *restrict width,
                               unsigned *restrict height)
 {
-- 
2.25.1