summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2012-10-03 19:42:42 +0200
committerSven Gothel <[email protected]>2012-10-03 19:42:42 +0200
commit5ac7a618808ca7964c74789e28f0a1e9b6e9c14e (patch)
treef5a52d9f372daa5369134fd5cd3e85674645ecf4 /src
parent3106532ef4d16e19f0ed3f9d8fa3634c3859e3f2 (diff)
Refine API doc of Buffers, fix API doc Platform.NEWLINE.
Diffstat (limited to 'src')
-rwxr-xr-xsrc/java/com/jogamp/common/nio/Buffers.java8
-rw-r--r--src/java/com/jogamp/common/os/Platform.java2
2 files changed, 9 insertions, 1 deletions
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.
diff --git a/src/java/com/jogamp/common/os/Platform.java b/src/java/com/jogamp/common/os/Platform.java
index 9b60f32..72a0b3d 100644
--- a/src/java/com/jogamp/common/os/Platform.java
+++ b/src/java/com/jogamp/common/os/Platform.java
@@ -381,7 +381,7 @@ public class Platform extends PlatformPropsImpl {
}
/**
- * Returns the JAVA vendor.
+ * Returns the platform's line separator.
*/
public static String getNewline() {
return NEWLINE;