From 603068a4e6af5293db10db73ead3a83b7a74af34 Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Sun, 19 Mar 2023 06:11:35 +0100
Subject: API doc cleanup, add + refine math tests

API doc
---
 src/jogl/classes/com/jogamp/opengl/GLRunnable.java | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'src/jogl/classes/com/jogamp/opengl/GLRunnable.java')

diff --git a/src/jogl/classes/com/jogamp/opengl/GLRunnable.java b/src/jogl/classes/com/jogamp/opengl/GLRunnable.java
index 97a72d6cd..f8bd56fdc 100644
--- a/src/jogl/classes/com/jogamp/opengl/GLRunnable.java
+++ b/src/jogl/classes/com/jogamp/opengl/GLRunnable.java
@@ -41,6 +41,13 @@ package com.jogamp.opengl;
  * The OpenGL context is current while executing the GLRunnable.
  * </p>
  * <p>
+ * {@link GLRunnable#run(GLAutoDrawable)} shall return true to indicate
+ * that the GL [back] framebuffer remains intact by this runnable. <br/>
+ * If returning false {@link GLAutoDrawable} will call
+ * {@link GLEventListener#display(GLAutoDrawable) display(GLAutoDrawable)}
+ * of all registered {@link GLEventListener}s once more to reinstate the framebuffer.
+ * </p>
+ * <p>
  * This might be useful to inject OpenGL commands from an I/O event listener.
  * </p>
  */
-- 
cgit v1.2.3