Kaydet (Commit) 3c691242 authored tarafından Michael Stahl's avatar Michael Stahl

offapi: fix even more doxygen warnings

Change-Id: Ic46ffa9423032a61ef79471c7cb4f2771c7f4270
üst a0d87361
...@@ -45,24 +45,38 @@ interface XProofreader: com::sun::star::linguistic2::XSupportedLocales ...@@ -45,24 +45,38 @@ interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
/** start checking /** start checking
@param nDocId @param aDocumentIdentifier
the Document ID. the Document ID.
@param rFlatParaText @param aText
the flat text to be checked. the flat text to be checked.
@param xFlatPara
the flat paragraph to be checked.
@param aLocale @param aLocale
Language used in the text. Language used in the text.
@param nStartOfSentencePos @param nStartOfSentencePosition
Start Index of the text. Start Index of the text.
@param nSuggestedSentenceEndPos @param nSuggestedBehindEndOfSentencePosition
Probable end position of the text. 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 @throws IllegalArgumentException
when any argument is wrong. when any argument is wrong.
*/ */
......
...@@ -37,7 +37,7 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface ...@@ -37,7 +37,7 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface
{ {
/** start proofreading and automatically process the whole text /** start proofreading and automatically process the whole text
@param xDoc @param xDocument
the text document. the text document.
@param xIteratorProvider @param xIteratorProvider
...@@ -52,13 +52,25 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface ...@@ -52,13 +52,25 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface
/** start proofreading from a given position /** start proofreading from a given position
@param xDoc @param xDocument
the document. the document.
@param xStartPara @param xFlatParagraph
the single flat paragraph to be checked. 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. the given index.
@throws IllegalArgumentException @throws IllegalArgumentException
...@@ -80,7 +92,7 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface ...@@ -80,7 +92,7 @@ interface XProofreadingIterator: com::sun::star::uno::XInterface
/** checks if the given document is currently being checked /** checks if the given document is currently being checked
@param xDoc @param xDocument
the document. the document.
@returns @returns
......
...@@ -121,6 +121,8 @@ published interface XLocale: com::sun::star::uno::XInterface ...@@ -121,6 +121,8 @@ published interface XLocale: com::sun::star::uno::XInterface
language code for display of field to user. If the localized language code for display of field to user. If the localized
name is not found, returns the ISO codes. name is not found, returns the ISO codes.
@param locale the locale.
@param inLocale @param inLocale
specifies the desired user language. specifies the desired user language.
*/ */
...@@ -138,6 +140,8 @@ published interface XLocale: com::sun::star::uno::XInterface ...@@ -138,6 +140,8 @@ published interface XLocale: com::sun::star::uno::XInterface
country code for display of field to user. If the localized country code for display of field to user. If the localized
name is not found, returns the ISO codes. name is not found, returns the ISO codes.
@param locale the locale.
@param inLocale @param inLocale
specifies the desired user country. specifies the desired user country.
*/ */
...@@ -154,6 +158,8 @@ published interface XLocale: com::sun::star::uno::XInterface ...@@ -154,6 +158,8 @@ published interface XLocale: com::sun::star::uno::XInterface
variant code for display of field to user. If the localized variant code for display of field to user. If the localized
name is not found, returns the ISO codes. name is not found, returns the ISO codes.
@param locale the locale.
@param inLocale @param inLocale
specifies the desired user variant. specifies the desired user variant.
*/ */
...@@ -164,6 +170,8 @@ published interface XLocale: com::sun::star::uno::XInterface ...@@ -164,6 +170,8 @@ published interface XLocale: com::sun::star::uno::XInterface
a string to display the entire locale to user. If the localized 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 name is not found, uses the ISO codes. The default locale is used
for the presentation language. for the presentation language.
@param locale the locale.
*/ */
string getDisplayName_Default( [in] com::sun::star::lang::Locale locale ); string getDisplayName_Default( [in] com::sun::star::lang::Locale locale );
...@@ -171,6 +179,8 @@ published interface XLocale: com::sun::star::uno::XInterface ...@@ -171,6 +179,8 @@ published interface XLocale: com::sun::star::uno::XInterface
a string to display the entire locale to user. If the localized a string to display the entire locale to user. If the localized
name is not found, uses the ISO codes. name is not found, uses the ISO codes.
@param locale the locale.
@param inLocale @param inLocale
specifies the desired user locale. specifies the desired user locale.
*/ */
......
...@@ -38,6 +38,8 @@ service Wizard : XWizard ...@@ -38,6 +38,8 @@ service Wizard : XWizard
/** creates a wizard with a single execution path /** creates a wizard with a single execution path
@param PageIds @param PageIds
the IDs of the pages which constitute the execution path. IDs must be in ascending order. the IDs of the pages which constitute the execution path. IDs must be in ascending order.
@param Controller
the wizard controller.
*/ */
createSinglePathWizard( createSinglePathWizard(
[in] sequence< short > PageIds, [in] sequence< short > PageIds,
...@@ -50,6 +52,8 @@ service Wizard : XWizard ...@@ -50,6 +52,8 @@ service Wizard : XWizard
@param PageIds @param PageIds
the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order. 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( createMultiplePathsWizard(
[in] sequence< sequence< short > > PageIds, [in] sequence< sequence< short > > PageIds,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment