summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2016-02-09 17:05:03 +0100
committerMichael Stahl <mstahl@redhat.com>2016-02-09 17:05:21 +0100
commit3c6912429252f6924b0d37e57c3760ebf1cf32b5 (patch)
tree20269861e0cf349e7af799b28ba715b07618eea0 /offapi/com/sun/star/linguistic2
parenta0d873615c5c11a8154da213171b50c50c081305 (diff)
offapi: fix even more doxygen warnings
Change-Id: Ic46ffa9423032a61ef79471c7cb4f2771c7f4270
Diffstat (limited to 'offapi/com/sun/star/linguistic2')
-rw-r--r--offapi/com/sun/star/linguistic2/XProofreader.idl28
-rw-r--r--offapi/com/sun/star/linguistic2/XProofreadingIterator.idl22
2 files changed, 38 insertions, 12 deletions
diff --git a/offapi/com/sun/star/linguistic2/XProofreader.idl b/offapi/com/sun/star/linguistic2/XProofreader.idl
index cf80eeb7e72a..ed918a327a27 100644
--- a/offapi/com/sun/star/linguistic2/XProofreader.idl
+++ b/offapi/com/sun/star/linguistic2/XProofreader.idl
@@ -45,24 +45,38 @@ interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
/** start checking
- @param nDocId
+ @param aDocumentIdentifier
the Document ID.
- @param rFlatParaText
+ @param aText
the flat text to be checked.
- @param xFlatPara
- the flat paragraph to be checked.
-
@param aLocale
Language used in the text.
- @param nStartOfSentencePos
+ @param nStartOfSentencePosition
Start Index of the text.
- @param nSuggestedSentenceEndPos
+ @param nSuggestedBehindEndOfSentencePosition
Probable end position of the text.
+ @param aProperties
+ additional properties of the text.
+
+ Currently the following properties may be supported:
+ <table>
+ <tr>
+ <td>FieldPositions</td>
+ <td>sequence&lt;long&gt;</td>
+ <td>indexes of fields in aText</td>
+ </tr>
+ <tr>
+ <td>FootnotePositions</td>
+ <td>sequence&lt;long&gt;</td>
+ <td>indexes of footnotes in aText</td>
+ </tr>
+ </table>
+
@throws IllegalArgumentException
when any argument is wrong.
*/
diff --git a/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl b/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl
index eec48ee068a8..063c1d0b30a7 100644
--- a/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl
+++ b/offapi/com/sun/star/linguistic2/XProofreadingIterator.idl
@@ -37,7 +37,7 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface
{
/** start proofreading and automatically process the whole text
- @param xDoc
+ @param xDocument
the text document.
@param xIteratorProvider
@@ -52,13 +52,25 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface
/** start proofreading from a given position
- @param xDoc
+ @param xDocument
the document.
- @param xStartPara
+ @param xFlatParagraph
the single flat paragraph to be checked.
- @param nErrorPosInPara
+ @param aText
+ the text of the paragraph to be checked.
+
+ @param aLocale
+ currently unused parameter.
+
+ @param nStartOfSentencePosition
+ the start position of the current sentence.
+
+ @param nSuggestedBehindEndOfSentencePosition
+ currently unused parameter.
+
+ @param nErrorPositionInParagraph
the given index.
@throws IllegalArgumentException
@@ -80,7 +92,7 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface
/** checks if the given document is currently being checked
- @param xDoc
+ @param xDocument
the document.
@returns