changeset 20920:badbe99cfaa4

RegisterConfig: improve javadoc for getAllocatableRegisters and filterAllocatableRegisters.
author Josef Eisl <josef.eisl@jku.at>
date Mon, 13 Apr 2015 17:10:40 +0200
parents c6545476bc77
children 2b10bb41a298
files graal/com.oracle.graal.api.code/src/com/oracle/graal/api/code/RegisterConfig.java
diffstat 1 files changed, 7 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.graal.api.code/src/com/oracle/graal/api/code/RegisterConfig.java	Mon Apr 13 17:00:21 2015 +0200
+++ b/graal/com.oracle.graal.api.code/src/com/oracle/graal/api/code/RegisterConfig.java	Mon Apr 13 17:10:40 2015 +0200
@@ -71,13 +71,17 @@
     Register[] getCallingConventionRegisters(Type type, Kind kind);
 
     /**
-     * Gets the set of registers that can be used by the register allocator.
+     * Gets the set of all registers that might be used by the register allocator.
+     *
+     * To get the set of registers the register allocator is allowed to use see
+     * {@link RegisterAllocationConfig#getAllocatableRegisters()}
      */
+    @SuppressWarnings("javadoc")
     Register[] getAllocatableRegisters();
 
     /**
-     * Gets the set of registers that can be used by the register allocator for a value of a
-     * particular kind.
+     * Filters a set of registers and returns only those that can be used by the register allocator
+     * for a value of a particular kind.
      */
     Register[] filterAllocatableRegisters(PlatformKind kind, Register[] registers);