offapi/com/sun/star/i18n/XBreakIterator.idl | 1
offapi/com/sun/star/sheet/XAreaLinks.idl | 7 +-
offapi/com/sun/star/sheet/XCellRangesQuery.idl | 16 +++--
offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl | 2
offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl | 24 +++++---
offapi/com/sun/star/sheet/XFunctionAccess.idl | 46 +++++++++--------
offapi/com/sun/star/sheet/XNamedRanges.idl | 11 ++--
offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl | 12 ++--
offapi/com/sun/star/sheet/XSheetLinkable.idl | 6 +-
9 files changed, 73 insertions(+), 52 deletions(-)
New commits:
commit d758550e2d1b4649377b527ad5a1a56c74c07519
Author: Nam Bui <ndbu...@gmail.com>
AuthorDate: Fri Jul 25 15:21:45 2025 -0400
Commit: Mike Kaganski <mike.kagan...@collabora.com>
CommitDate: Wed Aug 13 13:21:01 2025 +0200
tdf#158433 Doxygen: multiple paragraphs to parblocks
Follow-up patch to 6eff24aec6df.
Removed empty line after @endparblock in
com::sun::star::i18n::XBreakIterator.
Put multiple paragraphs to parblocks in
affected files in com::sun::star::sheet.
Change-Id: Ie36edb9ff8ba8f59ea53214ffcc08b348c92c834
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/188363
Tested-by: Jenkins
Reviewed-by: Mike Kaganski <mike.kagan...@collabora.com>
diff --git a/offapi/com/sun/star/i18n/XBreakIterator.idl
b/offapi/com/sun/star/i18n/XBreakIterator.idl
index 7e284169b4bf..8058b417e216 100644
--- a/offapi/com/sun/star/i18n/XBreakIterator.idl
+++ b/offapi/com/sun/star/i18n/XBreakIterator.idl
@@ -146,7 +146,6 @@ published interface XBreakIterator:
com::sun::star::uno::XInterface
mixed Western/CJK text may lead to wrong word iteration.
This is fixed in later versions.
@endparblock
-
@param nWordType
One of WordType, specifies the type of
traveling.
diff --git a/offapi/com/sun/star/sheet/XAreaLinks.idl
b/offapi/com/sun/star/sheet/XAreaLinks.idl
index d289470ef280..e68aace18ea3 100644
--- a/offapi/com/sun/star/sheet/XAreaLinks.idl
+++ b/offapi/com/sun/star/sheet/XAreaLinks.idl
@@ -40,11 +40,12 @@ published interface XAreaLinks:
com::sun::star::container::XIndexAccess
the URL of the source document.
@param aSourceArea
+ @parblock
the name of the range in the source document.
- <p>This can be the address of a cell or range in the form
- "Sheet1.A1:C5", or the name of a named range or database range.</p>
-
+ This can be the address of a cell or range in the form
+ "Sheet1.A1:C5", or the name of a named range or database range.
+ @endparblock
@param aFilter
the name of the filter used to load the source document.
diff --git a/offapi/com/sun/star/sheet/XCellRangesQuery.idl
b/offapi/com/sun/star/sheet/XCellRangesQuery.idl
index d2c5a491fce9..084d69c48484 100644
--- a/offapi/com/sun/star/sheet/XCellRangesQuery.idl
+++ b/offapi/com/sun/star/sheet/XCellRangesQuery.idl
@@ -34,7 +34,7 @@ published interface XCellRangesQuery:
com::sun::star::uno::XInterface
/** queries all visible cells.
@returns
- the visible (not hidden) cells of the current cell range(s).
+ The visible (not hidden) cells of the current cell range(s).
*/
com::sun::star::sheet::XSheetCellRanges queryVisibleCells();
@@ -42,7 +42,7 @@ published interface XCellRangesQuery:
com::sun::star::uno::XInterface
/** queries all empty cells.
@returns
- the empty cells of the current cell range(s).
+ The empty cells of the current cell range(s).
*/
com::sun::star::sheet::XSheetCellRanges queryEmptyCells();
@@ -50,16 +50,18 @@ published interface XCellRangesQuery:
com::sun::star::uno::XInterface
/** queries all cells with the specified content type(s).
@param nContentFlags
+ @parblock
a combination of CellFlags flags.
- <p>Attention: Despite the CellFlags flags are
+ Attention: Despite the CellFlags flags are
`long` values, this method expects a `short`
- parameter.</p>
+ parameter.
- <p>Attention: Empty cells in the range may be skipped depending on
+ Attention: Empty cells in the range may be skipped depending on
the content flag used. For instance, when querying for STYLES,
the returned ranges may not include empty cells even if styles are
- applied to those cells.</p>
+ applied to those cells.
+ @endparblock
@returns
all cells of the current cell range(s) with the specified
@@ -72,7 +74,7 @@ published interface XCellRangesQuery:
com::sun::star::uno::XInterface
/** queries all formula cells with the specified result type.
@param nResultFlags
- a combination of FormulaResult flags.
+ A combination of FormulaResult flags.
@returns
all formula cells of the current cell range(s) with the
diff --git a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl
b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl
index 2db8fd7649f4..523d764e8a44 100644
--- a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl
+++ b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl
@@ -68,6 +68,7 @@ published interface XDataPilotFieldGrouping:
com::sun::star::uno::XInterface
numeric ranges), otherwise an exception is thrown.</p>
@param aInfo
+ @parblock
contains the information how to group the items of the field. The
members of this struct have to fulfill the following requirements:
@@ -122,6 +123,7 @@ published interface XDataPilotFieldGrouping:
com::sun::star::uno::XInterface
<li>The contents of the member
DataPilotFieldGroupInfo::Groups will be ignored.</li>
</ul>
+ @endparblock
@returns
the new created field if there is one created. `NULL` is returned,
diff --git a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
index 78625481648c..6a7dae785b21 100644
--- a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
+++ b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl
@@ -59,29 +59,31 @@ interface XFormulaOpCodeMapper
is thrown.
@returns
+ @parblock
a sequence of FormulaToken matching the input
sequence in order.
- <p>Each string element in parameter Names according to the formula
+ Each string element in parameter Names according to the formula
language in parameter Language is mapped to a FormulaToken
containing the internal OpCode used by the spreadsheet
application in FormulaToken::OpCode and by
contract maybe additional information in
- FormulaToken::Data.</p>
+ FormulaToken::Data.
- <p>The order of the FormulaToken sequence returned matches the
- input order of the string sequence.</p>
+ The order of the FormulaToken sequence returned matches the
+ input order of the string sequence.
- <p>An unknown Name string gets the OpCode value of
- #OpCodeUnknown assigned.</p>
+ An unknown Name string gets the OpCode value of
+ #OpCodeUnknown assigned.
- <p>Additional information in FormulaToken::Data
+ Additional information in FormulaToken::Data
is returned for:
<ul>
<li>Add-in names: the programmatic name. The OpCode value used
for add-ins can be queried with the #OpCodeExternal
getter method.</li>
- </ul></p>
+ </ul>
+ @endparblock
*/
sequence< FormulaToken > getMappings(
[in] sequence< string > Names,
@@ -103,14 +105,16 @@ interface XFormulaOpCodeMapper
FormulaMapGroup constants.
@returns
+ @parblock
Sequence of FormulaOpCodeMapEntry.
- <p>Each element of the formula language in parameter Language is
+ Each element of the formula language in parameter Language is
mapped to a FormulaToken containing the internal
OpCode used by the spreadsheet application in
FormulaToken::OpCode and by contract maybe additional
information in FormulaToken::Data. See
- getMappings() for more details.</p>
+ getMappings() for more details.
+ @endparblock
*/
sequence< FormulaOpCodeMapEntry > getAvailableMappings(
[in] long Language, [in] long Groups )
diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl
b/offapi/com/sun/star/sheet/XFunctionAccess.idl
index 3f4bfefbdf99..001bf5c0fe82 100644
--- a/offapi/com/sun/star/sheet/XFunctionAccess.idl
+++ b/offapi/com/sun/star/sheet/XFunctionAccess.idl
@@ -31,39 +31,42 @@ published interface XFunctionAccess:
com::sun::star::uno::XInterface
/** calls a function and returns the result of the call.
@param aName
- the (programmatic) name of the function.
+ the (programmatic) name of the function.
@param aArguments
- the arguments for the function call.
- <p>Each element must be of one of the following types:</p>
+ @parblock
+ the arguments for the function call.
+ Each element must be of one of the following types:
- <dl>
- <dt>`long` or `double`</dt>
- <dd>for a numeric value.</dd>
+ <dl>
+ <dt>`long` or `double`</dt>
+ <dd>for a numeric value.</dd>
- <dt>`string`</dt>
- <dd>for a textual value.</dd>
+ <dt>`string`</dt>
+ <dd>for a textual value.</dd>
- <dt>`long[][]` or `double[][]`</dt>
- <dd>for an array of numeric values.</dd>
+ <dt>`long[][]` or `double[][]`</dt>
+ <dd>for an array of numeric values.</dd>
- <dt>`string[][]`</dt>
- <dd>for an array of textual values.</dd>
+ <dt>`string[][]`</dt>
+ <dd>for an array of textual values.</dd>
- <dt>`any[][]`</dt>
- <dd>for a mixed array, where each element must be of `VOID`,
- `long`, `double` or `string`
- type.</dd>
+ <dt>`any[][]`</dt>
+ <dd>for a mixed array, where each element must be of `VOID`,
+ `long`, `double` or `string`
+ type.</dd>
- <dt>com::sun::star::table::XCellRange</dt>
- <dd>for a SheetCellRange object that contains the
- data.</dd>
- </dl>
+ <dt>com::sun::star::table::XCellRange</dt>
+ <dd>for a SheetCellRange object that contains the
+ data.</dd>
+ </dl>
+ @endparblock
@returns
+ @parblock
the result of the function call.
- <p>Possible types for the result are:</p>
+ Possible types for the result are:
<dl>
<dt>`VOID`</dt>
@@ -79,6 +82,7 @@ published interface XFunctionAccess:
com::sun::star::uno::XInterface
<dd>for an array result, containing `double` and
`string` values.</dd>
</dl>
+ @endparblock
@throws com::sun::star::container::NoSuchElementException
if the named function does not exist.
diff --git a/offapi/com/sun/star/sheet/XNamedRanges.idl
b/offapi/com/sun/star/sheet/XNamedRanges.idl
index 8797175f0498..12875cb17420 100644
--- a/offapi/com/sun/star/sheet/XNamedRanges.idl
+++ b/offapi/com/sun/star/sheet/XNamedRanges.idl
@@ -36,19 +36,22 @@ published interface XNamedRanges:
com::sun::star::container::XNameAccess
the new name of the named range.
@param aContent
+ @parblock
the formula expression.
- <p>A cell range address is one possible content of a named
- range.</p>
-
+ A cell range address is one possible content of a named
+ range.
+ @endparblock
@param aPosition
specifies the base address for relative cell references.
@param nType
+ @parblock
a combination of flags that specify the type of a named range,
as defined in NamedRangeFlag.
- <p>This parameter will be zero for any common named range.</p>
+ This parameter will be zero for any common named range.
+ @endparblock
*/
void addNewByName(
[in] string aName,
diff --git a/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
index 08d8d207e4b0..51e7eaf5b85c 100644
--- a/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
+++ b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl
@@ -46,10 +46,12 @@ published interface XSheetCellRangeContainer:
com::sun::star::sheet::XSheetCellR
/** removes the given range from the collection of cell ranges.
@param aCellRangeAddress
+ @parblock
contains the address of the range to be removed.
- <p>The specified range must fit exactly to an element of the
- collection. The method does not try to shorten a range.</p>
+ The specified range must fit exactly to an element of the
+ collection. The method does not try to shorten a range.
+ @endparblock
@throws com::sun::star::container::NoSuchElementException
if the collection does not contain the specified range.
@@ -76,10 +78,12 @@ published interface XSheetCellRangeContainer:
com::sun::star::sheet::XSheetCellR
/** removes the given ranges from the collection of cell ranges.
@param aCellRangeAddresses
+ @parblock
contains a sequence of addresses of all ranges to be removed.
- <p>All specified ranges must fit exactly to elements of the
- collection. The method does not try to shorten ranges.</p>
+ All specified ranges must fit exactly to elements of the
+ collection. The method does not try to shorten ranges.
+ @endparblock
@throws com::sun::star::container::NoSuchElementException
if the collection does not contain any of the specified ranges.
diff --git a/offapi/com/sun/star/sheet/XSheetLinkable.idl
b/offapi/com/sun/star/sheet/XSheetLinkable.idl
index 5582843d9130..b775bcddf727 100644
--- a/offapi/com/sun/star/sheet/XSheetLinkable.idl
+++ b/offapi/com/sun/star/sheet/XSheetLinkable.idl
@@ -49,11 +49,13 @@ published interface XSheetLinkable:
com::sun::star::uno::XInterface
are copied.
@param nLinkMode
+ @parblock
the value specifying the link mode for this spreadsheet.
- <p>If the value is SheetLinkMode::NORMAL,
+ If the value is SheetLinkMode::NORMAL,
formulas are copied. With SheetLinkMode::VALUE,
- only results of formulas are used.</p>
+ only results of formulas are used.
+ @endparblock
*/
void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode );
