Consider, for example, HasUnoInterfaces Function help page [1]. It has a "syntax" part. The following "Parameters" section does not explicitly mention the types of the arguments passed to the function. The implementation of the function [2] expects the first argument to be Object, and the rest String. This must be mentioned in the help page directly at every argument. All the help pages for Basic functions have proper Basic types of all arguments and return values explicitly stated. [1] https://help.libreoffice.org/24.8/en-US/text/sbasic/shared/03104400.html?DbPAR=BASIC [2] https://opengrok.libreoffice.org/xref/core/basic/source/classes/sbunoobj.cxx?r=ee4554b0&fi=RTL_Impl_HasInterfaces#RTL_Impl_HasInterfaces
It would be nice, if both Return Value, and Parameters, were table; the return value could be the last row of that table, with the "name" like [return value]. The "Type" column would only contain the proper Basic type; and the last column would describe the element: e.g., for "return value", part of the text could be moved from above, like > Name Type Description > ------------------------------------------------------------------------- > oTest Object the Basic Uno object that you want to test. > ------------------------------------------------------------------------- > Uno-Interface-Name 1, String Uno interface name(s) > Uno-Interface-Name 2, > ... > ------------------------------------------------------------------------- > [Return value] Boolean True, if all stated Uno interfaces are > supported, otherwise False Note that current text at "oTest", mentioning "the Basic Uno object" in a free-text description, is not a proper API-documentation-style type definition. It is OK to have that description, but it doesn't replace the formal type name of the language.
(In reply to Mike Kaganski from comment #0) > All the help pages for Basic functions have proper Basic types of all > arguments and return values explicitly stated. Of course, the intention was "All the help pages for Basic functions MUST have proper Basic types ...", I forgot to type "MUST".
Olivier Hallot committed a patch related to this issue. It has been pushed to "master": https://git.libreoffice.org/help/commit/665361b6e25061def1bb387eb4c2b3c9fbee5c62 tdf#163745 BASIC help pages must explicitly state types
Olivier Hallot committed a patch related to this issue. It has been pushed to "master": https://git.libreoffice.org/help/commit/50ac2a4859e37571f39df2a00a250d0d97db121f tdf#163745 BASIC help pages must explicitly state types
Olivier Hallot committed a patch related to this issue. It has been pushed to "master": https://git.libreoffice.org/help/commit/4e20b30849bd3149067a8680cfb80d71008ff892 tdf#163745 BASIC help pages must explicitly state types of all arguments