[Libreoffice-commits] core.git: 2 commits - offapi/com udkapi/com
Michael Stahl
mstahl at redhat.com
Tue Feb 9 16:07:19 UTC 2016
offapi/com/sun/star/linguistic2/XProofreader.idl | 28 +++++++---
offapi/com/sun/star/linguistic2/XProofreadingIterator.idl | 22 ++++++-
offapi/com/sun/star/resource/XLocale.idl | 10 +++
offapi/com/sun/star/ui/dialogs/Wizard.idl | 4 +
udkapi/com/sun/star/registry/XImplementationRegistration.idl | 3 +
udkapi/com/sun/star/registry/XImplementationRegistration2.idl | 3 +
udkapi/com/sun/star/script/XDebugging.idl | 4 +
udkapi/com/sun/star/script/XDirectInvocation.idl | 1
udkapi/com/sun/star/script/XInvocation.idl | 1
9 files changed, 63 insertions(+), 13 deletions(-)
New commits:
commit 3c6912429252f6924b0d37e57c3760ebf1cf32b5
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Feb 9 17:05:03 2016 +0100
offapi: fix even more doxygen warnings
Change-Id: Ic46ffa9423032a61ef79471c7cb4f2771c7f4270
diff --git a/offapi/com/sun/star/linguistic2/XProofreader.idl b/offapi/com/sun/star/linguistic2/XProofreader.idl
index cf80eeb..ed918a3 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<long></td>
+ <td>indexes of fields in aText</td>
+ </tr>
+ <tr>
+ <td>FootnotePositions</td>
+ <td>sequence<long></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 eec48ee..063c1d0 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
diff --git a/offapi/com/sun/star/resource/XLocale.idl b/offapi/com/sun/star/resource/XLocale.idl
index ed4c987..fe37fcc 100644
--- a/offapi/com/sun/star/resource/XLocale.idl
+++ b/offapi/com/sun/star/resource/XLocale.idl
@@ -121,6 +121,8 @@ published interface XLocale: com::sun::star::uno::XInterface
language code for display of field to user. If the localized
name is not found, returns the ISO codes.
+ @param locale the locale.
+
@param inLocale
specifies the desired user language.
*/
@@ -138,6 +140,8 @@ published interface XLocale: com::sun::star::uno::XInterface
country code for display of field to user. If the localized
name is not found, returns the ISO codes.
+ @param locale the locale.
+
@param inLocale
specifies the desired user country.
*/
@@ -154,6 +158,8 @@ published interface XLocale: com::sun::star::uno::XInterface
variant code for display of field to user. If the localized
name is not found, returns the ISO codes.
+ @param locale the locale.
+
@param inLocale
specifies the desired user variant.
*/
@@ -164,6 +170,8 @@ published interface XLocale: com::sun::star::uno::XInterface
a string to display the entire locale to user. If the localized
name is not found, uses the ISO codes. The default locale is used
for the presentation language.
+
+ @param locale the locale.
*/
string getDisplayName_Default( [in] com::sun::star::lang::Locale locale );
@@ -171,6 +179,8 @@ published interface XLocale: com::sun::star::uno::XInterface
a string to display the entire locale to user. If the localized
name is not found, uses the ISO codes.
+ @param locale the locale.
+
@param inLocale
specifies the desired user locale.
*/
diff --git a/offapi/com/sun/star/ui/dialogs/Wizard.idl b/offapi/com/sun/star/ui/dialogs/Wizard.idl
index dba330a..f715649 100644
--- a/offapi/com/sun/star/ui/dialogs/Wizard.idl
+++ b/offapi/com/sun/star/ui/dialogs/Wizard.idl
@@ -38,6 +38,8 @@ service Wizard : XWizard
/** creates a wizard with a single execution path
@param PageIds
the IDs of the pages which constitute the execution path. IDs must be in ascending order.
+ @param Controller
+ the wizard controller.
*/
createSinglePathWizard(
[in] sequence< short > PageIds,
@@ -50,6 +52,8 @@ service Wizard : XWizard
@param PageIds
the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order.
+ @param Controller
+ the wizard controller.
*/
createMultiplePathsWizard(
[in] sequence< sequence< short > > PageIds,
commit a0d873615c5c11a8154da213171b50c50c081305
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Feb 9 16:09:10 2016 +0100
udkapi: fix doxygen warnings
Change-Id: I5f8c8df369aa7bb7f0647dbf4b25c39203d11b34
diff --git a/udkapi/com/sun/star/registry/XImplementationRegistration.idl b/udkapi/com/sun/star/registry/XImplementationRegistration.idl
index 13d0317..40da303 100644
--- a/udkapi/com/sun/star/registry/XImplementationRegistration.idl
+++ b/udkapi/com/sun/star/registry/XImplementationRegistration.idl
@@ -36,6 +36,9 @@ published interface XImplementationRegistration: com::sun::star::uno::XInterface
{
/** registers a component which provides one or more implementations.
+ @param aImplementationLoader
+ the URL of the implementation loader.
+
@param aLocation
specifies the location of the component with the URL.
diff --git a/udkapi/com/sun/star/registry/XImplementationRegistration2.idl b/udkapi/com/sun/star/registry/XImplementationRegistration2.idl
index 1581161..3b6a969 100644
--- a/udkapi/com/sun/star/registry/XImplementationRegistration2.idl
+++ b/udkapi/com/sun/star/registry/XImplementationRegistration2.idl
@@ -33,6 +33,9 @@ interface XImplementationRegistration2: com::sun::star::registry::XImplementatio
/** registers a component which provides one or more implementations.
+ @param aImplementationLoader
+ the URL of the implementation loader.
+
@param aLocation
specifies the location of the component with the URL.
diff --git a/udkapi/com/sun/star/script/XDebugging.idl b/udkapi/com/sun/star/script/XDebugging.idl
index 64cc747..ace72cc 100644
--- a/udkapi/com/sun/star/script/XDebugging.idl
+++ b/udkapi/com/sun/star/script/XDebugging.idl
@@ -49,11 +49,13 @@ published interface XDebugging: com::sun::star::uno::XInterface
/** Evaluates an expression.
- @returns the value of the expression as string.
+ @param aSourceCode the expression to be evaluated.
@param nCallStackPos Position in the call stack for which the expression
should be evaluated. 0 is the top/actual position in the call
in the call stack, 1 the next and so on.
+
+ @returns the value of the expression as string.
*/
string eval( [in] string aSourceCode,
[in] short nCallStackPos );
diff --git a/udkapi/com/sun/star/script/XDirectInvocation.idl b/udkapi/com/sun/star/script/XDirectInvocation.idl
index 801ad43..ff21fb1 100644
--- a/udkapi/com/sun/star/script/XDirectInvocation.idl
+++ b/udkapi/com/sun/star/script/XDirectInvocation.idl
@@ -39,6 +39,7 @@ published interface XDirectInvocation: com::sun::star::uno::XInterface
{
/** provides access to methods and properties exposed by an object.
+ @param aName the method to invoke
@param aParams all parameters, out parameters are not supported
*/
any directInvoke( [in] string aName,
diff --git a/udkapi/com/sun/star/script/XInvocation.idl b/udkapi/com/sun/star/script/XInvocation.idl
index 7545fdb..0db1a9a 100644
--- a/udkapi/com/sun/star/script/XInvocation.idl
+++ b/udkapi/com/sun/star/script/XInvocation.idl
@@ -51,6 +51,7 @@ published interface XInvocation: com::sun::star::uno::XInterface
/** provides access to methods exposed by an object.
+ @param aFunctionName the method to invoke
@param aParams all parameters; pure out params are undefined in sequence,
the value has to be ignored by the callee
@param aOutParamIndex This sequence contains the indices of all parameters
More information about the Libreoffice-commits
mailing list