From 4f63dd8b374ce6e5c6fd783625c287eef6079265 Mon Sep 17 00:00:00 2001 From: Michael Weghorn Date: Tue, 16 Jul 2024 10:51:59 +0200 Subject: a11y: Clean up XAccessibleAction doc The `XAccessibleAction::getAccessibleActionDescription` and `XAcccessibleAction::doAccessibleAction` doc mentions that an `IndexOutOfBoundsException` exception is thrown when the index is invalid, which is indeed the expected behaviour. However, they mentioned in addition that false or an empty string is returned, which doesn't make sense when exception gets thrown, so drop that. Also slightly improve wording at 2 other places. Change-Id: Idcc1fd669f32ff5a160cb35d2fbf6c2d23f65ab9 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/170567 Reviewed-by: Michael Weghorn Tested-by: Jenkins --- offapi/com/sun/star/accessibility/XAccessibleAction.idl | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'offapi') diff --git a/offapi/com/sun/star/accessibility/XAccessibleAction.idl b/offapi/com/sun/star/accessibility/XAccessibleAction.idl index bae281c8e98f..e35d049e1b44 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleAction.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleAction.idl @@ -47,8 +47,7 @@ interface XAccessibleAction : ::com::sun::star::uno::XInterface /** Perform the specified Action on the object. @param nIndex - This index specifies the action to perform. If it lies outside - the valid range `FALSE` is returned and no action is performed. + This index specifies the action to perform. @return Returns `TRUE` if the action was successfully performed. If the action could not be performed successfully `FALSE` is @@ -66,14 +65,13 @@ interface XAccessibleAction : ::com::sun::star::uno::XInterface @param nIndex This index specifies the action of which to return a - description. If it lies outside the valid range an empty string - is returned. + description. @return The returned value is a localized string of the specified action. @throws IndexOutOfBoundsException - If the given index lies not in the valid range then an + If the given index does not lie in the valid range then a ::com::sun::star::lang::IndexOutOfBoundsException exception is thrown. */ @@ -86,7 +84,7 @@ interface XAccessibleAction : ::com::sun::star::uno::XInterface more information about how key bindings are represented. @param nIndex - This index specifies the action of which to return the key + This index specifies the action for which to return the key binding. @return -- cgit v1.2.3