changeset 16966:e92bc7d8e2dd

NFI: adopt JavaDoc
author Matthias Grimmer <grimmer@ssw.jku.at>
date Wed, 27 Aug 2014 09:14:19 +0200
parents c0376739e835
children c5db657d93c1 818844f7224d
files graal/com.oracle.nfi/src/com/oracle/nfi/api/NativeFunctionInterface.java
diffstat 1 files changed, 11 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.nfi/src/com/oracle/nfi/api/NativeFunctionInterface.java	Wed Aug 27 09:13:37 2014 +0200
+++ b/graal/com.oracle.nfi/src/com/oracle/nfi/api/NativeFunctionInterface.java	Wed Aug 27 09:14:19 2014 +0200
@@ -51,8 +51,8 @@
      *
      * @param libraries the ordered list of libraries to search for the function
      * @param name the name of the function to be resolved
-     * @return a pointer to the native function
-     * @throws UnsatisfiedLinkError if the function could not be resolved
+     * @return a pointer to the native function, or <code>null</code> if the function pointer could
+     *         not be resolved
      */
     NativeFunctionPointer getFunctionPointer(NativeLibraryHandle[] libraries, String name);
 
@@ -65,8 +65,8 @@
      * @param name the name of the function to be resolved
      * @param returnType the type of the return value
      * @param argumentTypes the types of the arguments
-     * @return the function handle of the native function
-     * @throws UnsatisfiedLinkError if the function handle could not be resolved
+     * @return the function handle of the native function, or <code>null</code> if the function
+     *         handle could not be resolved
      */
     NativeFunctionHandle getFunctionHandle(NativeLibraryHandle library, String name, Class<?> returnType, Class<?>... argumentTypes);
 
@@ -78,8 +78,8 @@
      * @param functionPointer a function pointer
      * @param returnType the type of the return value
      * @param argumentTypes the types of the arguments
-     * @return the function handle of the native function
-     * @throws UnsatisfiedLinkError the function handle could not be created
+     * @return the function handle of the native function, or <code>null</code> if the function
+     *         handle could not be resolved
      */
     NativeFunctionHandle getFunctionHandle(NativeFunctionPointer functionPointer, Class<?> returnType, Class<?>... argumentTypes);
 
@@ -92,8 +92,8 @@
      * @param name the name of the function to be resolved
      * @param returnType the type of the return value
      * @param argumentTypes the types of the arguments
-     * @return the function handle of the native function
-     * @throws UnsatisfiedLinkError if the function handle could not be created
+     * @return the function handle of the native function, or <code>null</code> if the function
+     *         handle could not be resolved
      */
     NativeFunctionHandle getFunctionHandle(NativeLibraryHandle[] libraries, String name, Class<?> returnType, Class<?>... argumentTypes);
 
@@ -105,10 +105,9 @@
      * @param name the name of the function to be resolved
      * @param returnType the type of the return value
      * @param argumentTypes the types of the arguments
-     * @return the function handle of the native function
-     * @throws UnsatisfiedLinkError if default library searching is not
-     *             {@linkplain #isDefaultLibrarySearchSupported() supported} or if the function
-     *             could not be resolved
+     * @return the function handle of the native function, or <code>null</code> if default library
+     *         searching is not {@linkplain #isDefaultLibrarySearchSupported() supported} or if the
+     *         function could not be resolved
      */
     NativeFunctionHandle getFunctionHandle(String name, Class<?> returnType, Class<?>... argumentTypes);