From 748ad7e1e0d58d4e1f4bb41cea39af091b5bf5dd Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Thu, 23 Jan 2014 19:38:28 +0100
Subject: Platform: Fix API doc of getCPUFamily(), getCPUType() and
 getABIType()

---
 src/java/com/jogamp/common/os/Platform.java | 12 +++++++++---
 1 file 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;
-- 
cgit v1.2.3