From c14a6d0d3526bb7bb9366bf8e877eaae0164bc82 Mon Sep 17 00:00:00 2001 From: Tor Lillqvist Date: Mon, 22 Dec 2014 14:29:29 +0200 Subject: Clarify what "ID" means Change-Id: Idfc3e90acf8fecaff5d11964c2197bf1610f558b --- offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl b/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl index 9fe30989a7d7..cbf1af065435 100644 --- a/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl +++ b/offapi/com/sun/star/sheet/opencl/XOpenCLSelection.idl @@ -43,18 +43,29 @@ interface XOpenCLSelection : com::sun::star::uno::XInterface void disableAutomaticDeviceSelection(); /** - * Set the OpenCL device with the platform ID and device ID - * Uses the ID of the platform and the device + * Select the OpenCL device with the given platform and device + * number. The platform number corresponds to an index into the + * sequence returned by getOpenCLPlatforms, and the device number + * corresponds to an index into the sequence of devices in that + * platform. */ void selectOpenCLDevice( [in] long platform, [in] long device ); /** - * returns the platform id of the currently selected device + * returns the index of the platform of the currently selected + * device. This is an index into the sequence that + * getOpenCLPlatforms returns in the current instance of + * LibreOffice (and not some a priori defined identifier for an + * OpenCL platform). */ long getPlatformID(); /** - * returns the device id of the currently selected device + * returns the index of the currently selected device. This is an + * index into the sequence of devices in the OpenCLPLatform object + * the device is part of in the current instance of LibreOffice + * (and not some a priori defined identifier for a specific model + * of device accessed through a specific platform). */ long getDeviceID(); -- cgit