From c2390fd3fff3853e7d71738da0d266a2399bf684 Mon Sep 17 00:00:00 2001 From: Michael Stahl Date: Fri, 5 Feb 2016 21:21:54 +0100 Subject: offapi: fix doxygen warnings Change-Id: Ibd7183423cf9f6c984218e8b896a9593f9c04a2e --- offapi/com/sun/star/sdb/XColumnUpdate.idl | 2 ++ offapi/com/sun/star/sdb/application/CopyTableWizard.idl | 8 ++++++++ .../com/sun/star/sdb/application/XDatabaseDocumentUI.idl | 8 +++++--- offapi/com/sun/star/sdbc/XBlob.idl | 3 +++ offapi/com/sun/star/sdbcx/XAuthorizable.idl | 16 ++++++++++++++++ .../com/sun/star/security/DocumentDigitalSignatures.idl | 7 ++++++- offapi/com/sun/star/smarttags/XSmartTagAction.idl | 6 +++++- offapi/com/sun/star/ucb/XSimpleFileAccess.idl | 3 +++ offapi/com/sun/star/ucb/XSimpleFileAccess3.idl | 3 +++ 9 files changed, 51 insertions(+), 5 deletions(-) (limited to 'offapi/com/sun') diff --git a/offapi/com/sun/star/sdb/XColumnUpdate.idl b/offapi/com/sun/star/sdb/XColumnUpdate.idl index 092656680996..784f6c75c1c5 100644 --- a/offapi/com/sun/star/sdb/XColumnUpdate.idl +++ b/offapi/com/sun/star/sdb/XColumnUpdate.idl @@ -149,6 +149,8 @@ published interface XColumnUpdate: com::sun::star::uno::XInterface /** updates a column with a stream value. @param x the new column value + @param length + the length of the stream @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl index 1bd2526bbb3d..3ba2e708959f 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl @@ -180,6 +180,14 @@ service CopyTableWizard : XCopyTableWizard can be used to intercept interactions (such as error messages) during the wizard run.

+ @param Source + the com::sun::star::sdb::DataAccessDescriptor describing the + target for the copy operation. + + @param Destination + the com::sun::star::sdb::DataAccessDescriptor describing the + target for the copy operation. + @param InteractionHandler specifies an interaction handler to use when user input is required. diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index d420a6b59e01..011b0333668d 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -285,14 +285,16 @@ interface XDatabaseDocumentUI

In opposite to createComponent(), this method allows you to specify additional arguments which are passed to the to-be-loaded component.

-

The meaning of the arguments is defined at the service which is effectively - created. See the above table for a list of those - services.

@param ObjectType specifies the type of the object, must be one of the DatabaseObject constants. + @param Arguments + The meaning of the arguments is defined at the service which is + effectively created. See the above + table for a list of those services. + @param DocumentDefinition Upon successful return, and if and only if ObjectType equals DatabaseObject::FORM or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition diff --git a/offapi/com/sun/star/sdbc/XBlob.idl b/offapi/com/sun/star/sdbc/XBlob.idl index 98bdb1eedd72..f40f8807403e 100644 --- a/offapi/com/sun/star/sdbc/XBlob.idl +++ b/offapi/com/sun/star/sdbc/XBlob.idl @@ -175,8 +175,11 @@ published interface XBlob: com::sun::star::uno::XInterface search for pattern begins at position start. + @param pattern the pattern to search + @param start + the start position for the search @returns the position @throws SQLException diff --git a/offapi/com/sun/star/sdbcx/XAuthorizable.idl b/offapi/com/sun/star/sdbcx/XAuthorizable.idl index 031d59adcaae..fae08415857a 100644 --- a/offapi/com/sun/star/sdbcx/XAuthorizable.idl +++ b/offapi/com/sun/star/sdbcx/XAuthorizable.idl @@ -28,17 +28,21 @@ /** is used for accessing and setting the permissions of a user for a database object. @see com::sun::star::sdbcx::PrivilegeObject + @see com::sun::star::sdbcx::Privilege */ published interface XAuthorizable: com::sun::star::uno::XInterface { /** retrieves the permissions for a specific object. + @param objName the name of the object @param objType a value of com::sun::star::sdbcx::PrivilegeObject + @returns the privileges + @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -47,12 +51,15 @@ published interface XAuthorizable: com::sun::star::uno::XInterface /** retrieves the permissions for a specific object, which could be granted to other users and groups. + @param objName the name of the object @param objType a value of com::sun::star::sdbcx::PrivilegeObject + @returns the grant privileges + @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -60,10 +67,14 @@ published interface XAuthorizable: com::sun::star::uno::XInterface (com::sun::star::sdbc::SQLException); /** adds additional permissions for a specific object. + @param objName the name of the object @param objType a value from the com::sun::star::sdbcx::PrivilegeObject constants group + @param objPrivileges + a value from the com::sun::star::sdbcx::Privilege constants group + @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -72,10 +83,15 @@ published interface XAuthorizable: com::sun::star::uno::XInterface (com::sun::star::sdbc::SQLException); /** removes permissions for a specific object from a group or user. + @param objName the name of the object @param objType a value from the com::sun::star::sdbcx::PrivilegeObject constants group + @param objPrivileges + a value from the com::sun::star::sdbcx::Privilege constants group + + @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/security/DocumentDigitalSignatures.idl b/offapi/com/sun/star/security/DocumentDigitalSignatures.idl index 6b4a8bcb7e92..7c43b422c8d0 100644 --- a/offapi/com/sun/star/security/DocumentDigitalSignatures.idl +++ b/offapi/com/sun/star/security/DocumentDigitalSignatures.idl @@ -45,8 +45,13 @@ service DocumentDigitalSignatures : XDocumentDigitalSignatures /** @param ODFVersion the version of the signature + + @param HasValidDocumentSignature + indicates if the document already contains a document signature. + */ - createWithVersionAndValidSignature([in] string ODFVersion, [in] boolean HasValidDocumentSignature); + createWithVersionAndValidSignature([in] string ODFVersion, + [in] boolean HasValidDocumentSignature); }; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/smarttags/XSmartTagAction.idl b/offapi/com/sun/star/smarttags/XSmartTagAction.idl index 005eb6f25db4..cf0537d60be4 100644 --- a/offapi/com/sun/star/smarttags/XSmartTagAction.idl +++ b/offapi/com/sun/star/smarttags/XSmartTagAction.idl @@ -108,7 +108,7 @@ interface XSmartTagAction: com::sun::star::lang::XInitialization raises( com::sun::star::lang::IndexOutOfBoundsException ); - /** obtains the number of actions provided for a specify smart tag + /** obtains the number of actions provided for a specified smart tag type. @param aSmartTagName @@ -118,6 +118,10 @@ interface XSmartTagAction: com::sun::star::lang::XInitialization @param xController The current controller of the document. + @param xProperties + Contains the smart tag properties collected by the smart + tag recognizer. + @return the number of actions available for the given smart tag type. diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl index 974f4eee0591..2ed62e0007e1 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl @@ -99,6 +99,9 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface /** Sets the "read only" of a file according to the boolean parameter, if the actual process has the right to do so. + @param FileURL + URL of the file + @param bReadOnly true; "read only" flag will be set, false; "read only" flag will be reset */ diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl index 99c27688a4b1..e67c9d7b898a 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl @@ -48,6 +48,9 @@ published interface XSimpleFileAccess3 : com::sun::star::ucb::XSimpleFileAccess2 if the actual process has the right to do so and the used operation system supports this operation. + @param FileURL + URL of the file + @param bHidden true; "hidden" flag will be set, false; "hidden" flag will be reset */ -- cgit