From 2cfb5fcc57878be040935503991a9c7ea150237a Mon Sep 17 00:00:00 2001
From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>
Date: Thu, 18 Aug 2022 11:21:35 +0200
Subject: Document Fl_Gl_Window::draw_begin() and draw_end().

---
 src/Fl_Gl_Window.cxx | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/Fl_Gl_Window.cxx b/src/Fl_Gl_Window.cxx
index c5cda4ab2..4295d4465 100644
--- a/src/Fl_Gl_Window.cxx
+++ b/src/Fl_Gl_Window.cxx
@@ -338,7 +338,10 @@ void Fl_Gl_Window::init() {
 */
 void Fl_Gl_Window::draw_overlay() {}
 
-
+/**
+ Supports drawing to an Fl_Gl_Window with the FLTK 2D drawing API.
+ \see \ref opengl_with_fltk_widgets
+ */
 void Fl_Gl_Window::draw_begin() {
   Fl_Surface_Device::push_current( Fl_OpenGL_Display_Device::display_device() );
   Fl_OpenGL_Graphics_Driver *drv = (Fl_OpenGL_Graphics_Driver*)Fl_Surface_Device::surface()->driver();
@@ -373,6 +376,10 @@ void Fl_Gl_Window::draw_begin() {
   // TODO: all of the settings should be saved on the GL stack
 }
 
+/**
+ To be used as a match for a previous call to Fl_Gl_Window::draw_begin().
+ \see \ref opengl_with_fltk_widgets
+ */
 void Fl_Gl_Window::draw_end() {
   glMatrixMode(GL_MODELVIEW_MATRIX);
   glPopMatrix();
-- 
cgit v1.2.3