From 5ac7a618808ca7964c74789e28f0a1e9b6e9c14e Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Wed, 3 Oct 2012 19:42:42 +0200
Subject: Refine API doc of Buffers, fix API doc Platform.NEWLINE.

---
 src/java/com/jogamp/common/nio/Buffers.java | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/java/com/jogamp/common/nio')

diff --git a/src/java/com/jogamp/common/nio/Buffers.java b/src/java/com/jogamp/common/nio/Buffers.java
index 1558887..b8145e9 100755
--- a/src/java/com/jogamp/common/nio/Buffers.java
+++ b/src/java/com/jogamp/common/nio/Buffers.java
@@ -256,6 +256,14 @@ public class Buffers {
     /**
      * Slices a ByteBuffer <i>or</i> a primitive float array to a FloatBuffer at the given position with the given size
      * in float-space.
+     * <p>
+     * The returned sliced buffer's start position is not necessarily zero,
+     * but the float position within the host ByteBuffer.
+     * </p>
+     * <p> 
+     * The returned sliced buffer is {@link FloatBuffer#mark() marked} at it's starting position. Hence
+     * {@link FloatBuffer#reset()} will rewind it to start after applying relative operations like {@link FloatBuffer#get()}.  
+     * </p>
      * <p> 
      * Using a ByteBuffer as the source guarantees 
      * keeping the source native order programmatically.  
-- 
cgit v1.2.3