From f725e45adebfecef7c91b27b2eb3ff69d2399e2a Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Sat, 26 Nov 2011 08:21:51 +0100
Subject: NEWT/GLContextImpl: Refine API doc, NEWT: Display name -> connection
 name

---
 src/newt/classes/com/jogamp/newt/Display.java     |  7 +++++--
 src/newt/classes/com/jogamp/newt/NewtFactory.java | 12 ++++++++----
 2 files changed, 13 insertions(+), 6 deletions(-)

(limited to 'src/newt')

diff --git a/src/newt/classes/com/jogamp/newt/Display.java b/src/newt/classes/com/jogamp/newt/Display.java
index 6a0ebe14a..7b6849a30 100644
--- a/src/newt/classes/com/jogamp/newt/Display.java
+++ b/src/newt/classes/com/jogamp/newt/Display.java
@@ -30,7 +30,6 @@ package com.jogamp.newt;
 
 import com.jogamp.newt.util.EDTUtil;
 import jogamp.newt.Debug;
-import jogamp.newt.DisplayImpl;
 
 import java.util.*;
 
@@ -130,7 +129,10 @@ public abstract class Display {
     public abstract int getId();
 
     /**
-     * @return this display instance name as defined at creation time
+     * @return This display connection name as defined at creation time. 
+     *         The display connection name is a technical platform specific detail, see {@link AbstractGraphicsDevice#getConnection()}. 
+     *
+     * @see AbstractGraphicsDevice#getConnection()
      */
     public abstract String getName();
 
@@ -198,6 +200,7 @@ public abstract class Display {
     }
 
     /** Returns the global display collection */
+    @SuppressWarnings("unchecked")
     public static Collection<Display> getAllDisplays() {
         ArrayList<Display> list;
         synchronized(displayList) {
diff --git a/src/newt/classes/com/jogamp/newt/NewtFactory.java b/src/newt/classes/com/jogamp/newt/NewtFactory.java
index 2a8a8182d..cb1da37c7 100644
--- a/src/newt/classes/com/jogamp/newt/NewtFactory.java
+++ b/src/newt/classes/com/jogamp/newt/NewtFactory.java
@@ -92,7 +92,8 @@ public class NewtFactory {
      * <p>
      * An already existing display connection of the same <code>name</code> will be reused.  
      * </p>
-     * @param name the display connection name
+     * @param name the display connection name which is a technical platform specific detail,
+     *        see {@link AbstractGraphicsDevice#getConnection()}. Use <code>null</code> for default.
      * @return the new or reused Display instance
      */
     public static Display createDisplay(String name) {
@@ -108,7 +109,8 @@ public class NewtFactory {
      * An already existing display connection of the same <code>name</code> will be reused
      * <b>if</b> <code>reuse</code> is <code>true</code>, otherwise a new instance is being created.
      * </p>
-     * @param name the display connection name
+     * @param name the display connection name which is a technical platform specific detail,
+     *        see {@link AbstractGraphicsDevice#getConnection()}. Use <code>null</code> for default.
      * @param reuse attempt to reuse an existing Display with same <code>name</code> if set true, otherwise create a new instance.
      * @return the new or reused Display instance
      */
@@ -125,7 +127,8 @@ public class NewtFactory {
      * An already existing display connection of the same <code>name</code> will be reused.
      * </p>
      * @param type explicit NativeWindow type eg. {@link NativeWindowFactory#TYPE_AWT}
-     * @param name the display connection name
+     * @param name the display connection name which is a technical platform specific detail,
+     *        see {@link AbstractGraphicsDevice#getConnection()}. Use <code>null</code> for default.
      * @return the new or reused Display instance
      */
     public static Display createDisplay(String type, String name) {
@@ -142,7 +145,8 @@ public class NewtFactory {
      * <b>if</b> <code>reuse</code> is <code>true</code>, otherwise a new instance is being created.
      * </p>
      * @param type explicit NativeWindow type eg. {@link NativeWindowFactory#TYPE_AWT}
-     * @param name the display connection name
+     * @param name the display connection name which is a technical platform specific detail,
+     *        see {@link AbstractGraphicsDevice#getConnection()}. Use <code>null</code> for default.
      * @param reuse attempt to reuse an existing Display with same <code>name</code> if set true, otherwise create a new instance.
      * @return the new or reused Display instance
      */
-- 
cgit v1.2.3