https://bugs.documentfoundation.org/show_bug.cgi?id=148646
Bug ID: 148646
Summary: Analysis functions taking XPropertySet argument need
explicit documentation
Product: LibreOffice
Version: unspecified
Hardware: All
URL: https://ask.libreoffice.org/t/need-for-xpropertyset-ob
ject-when-calling-getdec2hex/76567
OS: All
Status: UNCONFIRMED
Severity: normal
Priority: medium
Component: Documentation
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected]
Add-in functions and calling them from macros are documented at [1]. Naturally,
they are documented as implementation of respective spreadsheet functions.
But for some (most) of those, the implementation [2] takes more arguments than
the spreadsheet function takes: the internal code also passes an '[in]
com::sun::star::beans::XPropertySet xOptions' argument used to get
util::XNumberFormatsSupplier, used internally to convert between strings and
numbers.
The argument may be simply an empty reference (in which case, a default
locale-independent conversion would be used), so e.g. Basic macros may pass
'Nothing' constant as the value; or they may pass objects implementing the
XNumberFormatsSupplier interface [3] - like current document.
All this is not obvious for the reader of the current documentation, so it
would be nice to amend it with this information (which would require to list
arguments for each such function).
[1]
https://help.libreoffice.org/7.3/en-US/text/sbasic/shared/calc_functions.html?&DbPAR=CALC
[2]
https://opengrok.libreoffice.org/xref/core/scaddins/idl/com/sun/star/sheet/addin/XAnalysis.idl?r=cc7ff0c1
[3]
https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1util_1_1XNumberFormatsSupplier.html
--
You are receiving this mail because:
You are the assignee for the bug.
