From a3b43d569c198bad6d1708e394f772309a487101 Mon Sep 17 00:00:00 2001
From: Manolo Gouy <Manolo>
Date: Fri, 18 Sep 2015 15:29:30 +0000
Subject: Documentation: added warning that Fl_Gl_Window::mode(const int * a),
 although public, is subject to change, and that Fl_Gl_Window::mode(int a) is
 the adequate stable API.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10862 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_Gl_Window.H | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/FL/Fl_Gl_Window.H b/FL/Fl_Gl_Window.H
index 95333be4e..2c4b11250 100644
--- a/FL/Fl_Gl_Window.H
+++ b/FL/Fl_Gl_Window.H
@@ -173,9 +173,12 @@ public:
    \param a zero-ending array of platform-specific attributes and attribute values
    <p><b>Unix/Linux platform</b>: attributes are GLX attributes adequate for the 3rd argument of
    the <tt>glXChooseVisual()</tt> function (e.g., <tt>GLX_DOUBLEBUFFER</tt>).
+   \note What attributes are adequate here is subject to change.
+   The preferred, stable public API is Fl_Gl_Window::mode(int a).
    <p><b>MSWindows platform</b>: this member function is of no use.
    <p><b>Mac OS X platform</b>: attributes belong to the <tt>CGLPixelFormatAttribute</tt> enumeration
-   (e.g., <tt>kCGLPFADoubleBuffer</tt>) and may be followed by adequate attribute values.
+   (defined by including <tt><OpenGL/OpenGL.h></tt>, e.g., <tt>kCGLPFADoubleBuffer</tt>)
+   and may be followed by adequate attribute values.
    The pair <tt>kCGLPFAOpenGLProfile, kCGLOGLPVersion_3_2_Core</tt> allows to create an OpenGL V3.2 profile
    under Mac OS X 10.7 and above.
    */
-- 
cgit v1.2.3