aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2014-01-23 19:38:28 +0100
committerSven Gothel <[email protected]>2014-01-23 19:38:28 +0100
commit748ad7e1e0d58d4e1f4bb41cea39af091b5bf5dd (patch)
tree8999fd19e71db928e625bbbea56744cb3ccd048e /src
parent45f78321160cd6303a35ec52768367ef5ccef9e0 (diff)
Platform: Fix API doc of getCPUFamily(), getCPUType() and getABIType()
Diffstat (limited to 'src')
-rw-r--r--src/java/com/jogamp/common/os/Platform.java12
1 files changed, 9 insertions, 3 deletions
diff --git a/src/java/com/jogamp/common/os/Platform.java b/src/java/com/jogamp/common/os/Platform.java
index 23135ae..ee57d6a 100644
--- a/src/java/com/jogamp/common/os/Platform.java
+++ b/src/java/com/jogamp/common/os/Platform.java
@@ -315,21 +315,27 @@ public class Platform extends PlatformPropsImpl {
}
/**
- * Returns the CPU type.
+ * Returns the CPU family.
*/
public static CPUFamily getCPUFamily() {
return CPU_ARCH.getFamily();
}
/**
- * Returns the CPU architecture.
+ * Returns the CPU architecture type.
*/
public static CPUType getCPUType() {
return CPU_ARCH;
}
/**
- * Returns the (guessed) ABI.
+ * Returns the ABI type.
+ * <p>
+ * In case of {@link CPUFamily#ARM}, the value is determined by parsing the <i>Elf Headers</i> of the running VM.
+ * </p>
+ * <p>
+ * Otherwise the value is {@link ABIType#GENERIC_ABI}.
+ * </p>
*/
public static ABIType getABIType() {
return ABI_TYPE;