Mention how the new OpenCL configuration relates to this API

Change-Id: I0e5b8d7a6cca469efb263d0037b87e0a9475371e

1 files changed, 9 insertions, 2 deletions

diff --git a/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl b/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl
index 994867e6a069..9fe30989a7d7 100644
--- a/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl
+++ b/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl
@@ -15,12 +15,19 @@ interface XOpenCLSelection : com::sun::star::uno::XInterface
 {
 
     /**
-     * Returns true if calculation with OpenCL is enabled
+     * Returns true if calculation with OpenCL is enabled (at all).
+     * The actual use of OpenCL for a formula is also affected by the
+     * configuration settings specifying whether OpenCL is used for
+     * all opcodes or just for a subset, and the black- and whitelists
+     * of OpenCL implementations that are in use.
      */
     boolean isOpenCLEnabled();
 
     /**
-     * Enables or disables OpenCL
+     * Enables or disables use of OpenCL for calculations. When using
+     * this API to enable OpenCL the configuration parameters are set
+     * to their built-in default values, not ones read from the
+     * installation of user-specific configuration.
      */
     void enableOpenCL( [in] boolean enable );