From 207456b80e022608e6ee63e324de9367bf9f9d70 Mon Sep 17 00:00:00 2001 From: Aurimas FiĊĦeras Date: Tue, 25 Jan 2011 20:17:43 +0200 Subject: Some fixes to documentation (part 4) Fixes many spelling errors (checked with en_US spell checker). Unifies spelling of some common words. Replaces single quotes ('') with double quotes (""). Fixes several other errors. --- offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl | 2 +- offapi/com/sun/star/task/DocumentPasswordRequest.idl | 2 +- offapi/com/sun/star/task/DocumentPasswordRequest2.idl | 2 +- offapi/com/sun/star/task/ErrorCodeRequest.idl | 2 +- offapi/com/sun/star/task/InteractionHandler.idl | 12 ++++++------ offapi/com/sun/star/task/JobExecutor.idl | 2 +- offapi/com/sun/star/task/MasterPasswordRequest.idl | 2 +- offapi/com/sun/star/task/PasswordContainer.idl | 4 ++-- offapi/com/sun/star/task/PasswordRequest.idl | 2 +- offapi/com/sun/star/task/XAsyncJob.idl | 2 +- offapi/com/sun/star/task/XInteractionApprove.idl | 2 +- offapi/com/sun/star/task/XInteractionDisapprove.idl | 2 +- offapi/com/sun/star/task/XJob.idl | 6 +++--- offapi/com/sun/star/task/XJobExecutor.idl | 2 +- offapi/com/sun/star/task/XMasterPasswordHandling.idl | 2 +- offapi/com/sun/star/task/XMasterPasswordHandling2.idl | 2 +- offapi/com/sun/star/task/XPasswordContainer.idl | 8 ++++---- offapi/com/sun/star/task/XStatusIndicator.idl | 6 +++--- offapi/com/sun/star/task/XUrlContainer.idl | 2 +- offapi/com/sun/star/task/makefile.mk | 0 20 files changed, 32 insertions(+), 32 deletions(-) mode change 100755 => 100644 offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl mode change 100755 => 100644 offapi/com/sun/star/task/DocumentPasswordRequest2.idl mode change 100755 => 100644 offapi/com/sun/star/task/makefile.mk (limited to 'offapi/com/sun/star/task') diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl old mode 100755 new mode 100644 index 270784350a39..b88c6ced5436 --- a/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl @@ -52,7 +52,7 @@ module com { module sun { module star { module task { exception DocumentMSPasswordRequest2 : DocumentMSPasswordRequest { //------------------------------------------------------------------------- - /** specifies if the requested password is for opening a document or for mofiying it. + /** specifies if the requested password is for opening a document or for modifying it. */ boolean IsRequestPasswordToModify; diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest.idl b/offapi/com/sun/star/task/DocumentPasswordRequest.idl index 5520dc14f0ba..40bdff4dd343 100644 --- a/offapi/com/sun/star/task/DocumentPasswordRequest.idl +++ b/offapi/com/sun/star/task/DocumentPasswordRequest.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module task { //============================================================================= -/** this request specifies the mode in wich the password should be asked +/** this request specifies the mode in which the password should be asked

It is supported by InteractionHandler service, and can diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl old mode 100755 new mode 100644 index 35335d16c58b..df5b8915a65d --- a/offapi/com/sun/star/task/DocumentPasswordRequest2.idl +++ b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl @@ -51,7 +51,7 @@ module com { module sun { module star { module task { exception DocumentPasswordRequest2 : DocumentPasswordRequest { //------------------------------------------------------------------------- - /** specifies if the requested password is for opening a document or for mofiying it. + /** specifies if the requested password is for opening a document or for modifying it. */ boolean IsRequestPasswordToModify; diff --git a/offapi/com/sun/star/task/ErrorCodeRequest.idl b/offapi/com/sun/star/task/ErrorCodeRequest.idl index fb594a8b5944..2cd4575f16bc 100644 --- a/offapi/com/sun/star/task/ErrorCodeRequest.idl +++ b/offapi/com/sun/star/task/ErrorCodeRequest.idl @@ -39,7 +39,7 @@ /** represents a general error exception. It can be used to transport the error code information. - E.g. that can be usefull for interactions. + E.g. that can be useful for interactions. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/task/InteractionHandler.idl b/offapi/com/sun/star/task/InteractionHandler.idl index f772754d6d56..43ea8ae08315 100644 --- a/offapi/com/sun/star/task/InteractionHandler.idl +++ b/offapi/com/sun/star/task/InteractionHandler.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module task { //============================================================================ /** An interaction request handler that lets the user handle requests via GUI dialogs. -

The interaction handler service has a numerof of built-in handlers, responsible +

The interaction handler service has a number of built-in handlers, responsible for a lot of well known interactions. Additionally, there's a configuration module which allows to configure additional handlers, responsible for arbitrary requests.

@@ -127,7 +127,7 @@ module com { module sun { module star { module task {
"Folder"
IOErrorCode::CANT_CREATE - only. The name of the foler in which a resource cannot be created (a + only. The name of the folder in which a resource cannot be created (a string).
"Volume" and "OtherVolume"
@@ -137,7 +137,7 @@ module com { module sun { module star { module task {

-

Configurating additional Handlers

+

Configuring additional Handlers

It is possible to configure additional interaction handlers, to which certain requests can be delegated. The configuration node /org.openoffice.Interaction/InteractionHandlers is evaluated and respected @@ -147,12 +147,12 @@ module com { module sun { module star { module task { by full-qualified type name. Also, for each type, it can specify whether it is responsible for only this particular type, or all possibly existent derived types.

-

Whenever the InteractionHandler encounteres a request it cannot fulfill itself, it will examine +

Whenever the InteractionHandler encounters a request it cannot fulfill itself, it will examine the configuration, to find a handler implementation for the request, and delegate it to the first matching handler.

-

If multiple custom interaction handlers declare themself responsible for the same request type, it is not - defined which handler will actully be invoked. Thus, when deploying a custom interaction handler, ensure +

If multiple custom interaction handlers declare themselves responsible for the same request type, it is not + defined which handler will actually be invoked. Thus, when deploying a custom interaction handler, ensure that the types you specify are general enough to cover all requests you want to handle, but also specific enough to not cover requests which other handlers might be interested in.

*/ diff --git a/offapi/com/sun/star/task/JobExecutor.idl b/offapi/com/sun/star/task/JobExecutor.idl index 7f6a9581e0ab..2af18e08c5c1 100644 --- a/offapi/com/sun/star/task/JobExecutor.idl +++ b/offapi/com/sun/star/task/JobExecutor.idl @@ -42,7 +42,7 @@ module com { module sun { module star { module task {

Can start registered uno services on triggered events and handle there own configuration and there lifetime. Such events are simple strings - wich meaning doesn't matter for any real service implementation of this + which meaning doesn't matter for any real service implementation of this specification. But triggered events must be available inside the configuration and some Jobs or AsyncJobs must be registered for that.

diff --git a/offapi/com/sun/star/task/MasterPasswordRequest.idl b/offapi/com/sun/star/task/MasterPasswordRequest.idl index 734c4e00c1e4..e72468eaf3b4 100644 --- a/offapi/com/sun/star/task/MasterPasswordRequest.idl +++ b/offapi/com/sun/star/task/MasterPasswordRequest.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module task { //============================================================================= -/** this request specifies the mode in wich the password should be asked +/** this request specifies the mode in which the password should be asked

It is supported by InteractionHandler service, and can diff --git a/offapi/com/sun/star/task/PasswordContainer.idl b/offapi/com/sun/star/task/PasswordContainer.idl index e0bebf68f77d..565c3f835541 100644 --- a/offapi/com/sun/star/task/PasswordContainer.idl +++ b/offapi/com/sun/star/task/PasswordContainer.idl @@ -42,7 +42,7 @@ module com { module sun { module star { module task {

A password can be stored for the session period or persistently. The persistent way is only possible if configuration allows to use storage. - It stores passwords encripted with a super password. An interaction + It stores passwords encrypted with a super password. An interaction is used to ask a user for a super password. To allow such an interaction, an object that implements XInteractionHandler interface should be provided. For this purpose InteractionHandler @@ -54,7 +54,7 @@ module com { module sun { module star { module task { for the session period. In case an interaction handler is provided, but the super password interaction does not return super password ( for any reason ), NoMasterException exception is thrown to let user use - nonpersistent way explicitly. + non-persistent way explicitly.

*/ published service PasswordContainer diff --git a/offapi/com/sun/star/task/PasswordRequest.idl b/offapi/com/sun/star/task/PasswordRequest.idl index e9f32c86f72b..8a58340e48c4 100644 --- a/offapi/com/sun/star/task/PasswordRequest.idl +++ b/offapi/com/sun/star/task/PasswordRequest.idl @@ -41,7 +41,7 @@ module com { module sun { module star { module task { //============================================================================= -/** this request specifies the mode in wich the password should be asked +/** this request specifies the mode in which the password should be asked

It is supported by InteractionHandler service, and can diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl index 96dfe0365d9f..f4d3de2362f8 100644 --- a/offapi/com/sun/star/task/XAsyncJob.idl +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -52,7 +52,7 @@ module com { module sun { module star { module task {

Instead of XJob the implementation of this interface must be aware, that execution can be made real asynchronous (e.g. by using - threads). Because the environment whish to have creation and using of threads + threads). Because the environment wish to have creation and using of threads under control, it's not allowed for a real job implementation to use such mechanism by itself. The outside code decide, if it's possible and how it can be made asynchronous. In some special cases it can be, that asynchronous jobs will be executed diff --git a/offapi/com/sun/star/task/XInteractionApprove.idl b/offapi/com/sun/star/task/XInteractionApprove.idl index be39a0b21b2f..ffcfa1e20035 100644 --- a/offapi/com/sun/star/task/XInteractionApprove.idl +++ b/offapi/com/sun/star/task/XInteractionApprove.idl @@ -39,7 +39,7 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::task::XInteractionApprove -/** An intearaction continuation specifing 'approval'. +/** An interaction continuation specifying "approval". */ published interface XInteractionApprove: com::sun::star::task::XInteractionContinuation { diff --git a/offapi/com/sun/star/task/XInteractionDisapprove.idl b/offapi/com/sun/star/task/XInteractionDisapprove.idl index f4a21cc1c2b0..95cbf94aa7ac 100644 --- a/offapi/com/sun/star/task/XInteractionDisapprove.idl +++ b/offapi/com/sun/star/task/XInteractionDisapprove.idl @@ -39,7 +39,7 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::task::XInteractionDisapprove -/** An interaction continuation specifing 'disapproval'. +/** An interaction continuation specifying "disapproval". */ published interface XInteractionDisapprove: com::sun::star::task::XInteractionContinuation { diff --git a/offapi/com/sun/star/task/XJob.idl b/offapi/com/sun/star/task/XJob.idl index 759d7ca223c1..bd2b04d74f14 100644 --- a/offapi/com/sun/star/task/XJob.idl +++ b/offapi/com/sun/star/task/XJob.idl @@ -49,7 +49,7 @@ module com { module sun { module star { module task {

Instead of XAsyncJob the implementation of this interface - will be executed synchronously everytimes. That means: they can be shure that the + will be executed synchronously everytime. That means: they can be sure that the current stack context will be blocked till this job finish it's work.

@@ -82,8 +82,8 @@ published interface XJob : com::sun::star::uno::XInterface was corrupt so the service couldn't work correctly @throws com::sun::star::uno::Exception - to notify the excutor about faild operation; otherwise the return value - indicates a successfull finishing. + to notify the executor about failed operation; otherwise the return value + indicates a successful finishing. */ any execute( [in] sequence< com::sun::star::beans::NamedValue > Arguments ) diff --git a/offapi/com/sun/star/task/XJobExecutor.idl b/offapi/com/sun/star/task/XJobExecutor.idl index d4ef207235e7..047c7116d7d7 100644 --- a/offapi/com/sun/star/task/XJobExecutor.idl +++ b/offapi/com/sun/star/task/XJobExecutor.idl @@ -57,7 +57,7 @@ published interface XJobExecutor : com::sun::star::uno::XInterface

Jobs are registered in configuration and will be started by executor - automaticly, if they are registered for triggered event. + automatically, if they are registered for triggered event. The meaning of given string Event mustn't be known. Because for the executor it's enough to use it for searching a registered job inside his own configuration. So no special events will be defined here. diff --git a/offapi/com/sun/star/task/XMasterPasswordHandling.idl b/offapi/com/sun/star/task/XMasterPasswordHandling.idl index bd0637210052..591148b00bd5 100644 --- a/offapi/com/sun/star/task/XMasterPasswordHandling.idl +++ b/offapi/com/sun/star/task/XMasterPasswordHandling.idl @@ -54,7 +54,7 @@ published interface XMasterPasswordHandling : com::sun::star::uno::XInterface

- The call will use the standard interactin handler service + The call will use the standard interaction handler service InteractionHandler if no handler is provided.

diff --git a/offapi/com/sun/star/task/XMasterPasswordHandling2.idl b/offapi/com/sun/star/task/XMasterPasswordHandling2.idl index 201ed9081cdb..fa6cd2a8766b 100644 --- a/offapi/com/sun/star/task/XMasterPasswordHandling2.idl +++ b/offapi/com/sun/star/task/XMasterPasswordHandling2.idl @@ -49,7 +49,7 @@ interface XMasterPasswordHandling2 : XMasterPasswordHandling

Please use this method with care. Using of default master password let - the passwords be stored nonencrypted. If a masterpassword is predefined + the passwords be stored non-encrypted. If a master password is predefined in the algorithm it is no more an encryption, it is just an encoding.

*/ diff --git a/offapi/com/sun/star/task/XPasswordContainer.idl b/offapi/com/sun/star/task/XPasswordContainer.idl index 20aaf752a8e5..b363aa1684b6 100644 --- a/offapi/com/sun/star/task/XPasswordContainer.idl +++ b/offapi/com/sun/star/task/XPasswordContainer.idl @@ -59,7 +59,7 @@ published interface XPasswordContainer : com::sun::star::uno::XInterface @param Passwords The password-list. - @param Handler The handler to get superpassword to en/decript passwords + @param Handler The handler to get super password to en/decrypt passwords */ @@ -75,7 +75,7 @@ published interface XPasswordContainer : com::sun::star::uno::XInterface @param Passwords The password-list. - @param Handler The handler to get superpassword to en/decript passwords + @param Handler The handler to get super password to en/decrypt passwords */ @@ -86,7 +86,7 @@ published interface XPasswordContainer : com::sun::star::uno::XInterface @param Url URL-pattern to retrieve password for. - @param Handler The handler to get superpassword to en/decript passwords + @param Handler The handler to get super password to en/decrypt passwords @returns Best matched url-pattern with user-records list. */ @@ -99,7 +99,7 @@ published interface XPasswordContainer : com::sun::star::uno::XInterface @param UserName Username to retrieve passwords for. - @param Handler The handler to get superpassword to en/decript passwords + @param Handler The handler to get super password to en/decrypt passwords @returns Best matched url-pattern for the username. */ diff --git a/offapi/com/sun/star/task/XStatusIndicator.idl b/offapi/com/sun/star/task/XStatusIndicator.idl index d3a222d51a36..d7fcc76b246a 100644 --- a/offapi/com/sun/star/task/XStatusIndicator.idl +++ b/offapi/com/sun/star/task/XStatusIndicator.idl @@ -51,7 +51,7 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface /** initialize and start the progress

- It activates a new created or reactivate an already used inidicator + It activates a new created or reactivate an already used indicator (must be finished by calling XStatusIndicator::end() before!). By the way it's possible to set first progress description and the possible range of progress value. That means that a progress @@ -63,7 +63,7 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface Value can be updated by calling XStatusIndicator::setText(). @param Range - mewns the maximum value of the progress which can be setted by + means the maximum value of the progress which can be set by calling XStatusIndicator::setValue(). */ [oneway] void start( @@ -104,7 +104,7 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface

Wrong values must be ignored and stopped indicators must ignore this - call generaly. + call generally.

@param Value diff --git a/offapi/com/sun/star/task/XUrlContainer.idl b/offapi/com/sun/star/task/XUrlContainer.idl index ac55107c67f0..84b926569dac 100644 --- a/offapi/com/sun/star/task/XUrlContainer.idl +++ b/offapi/com/sun/star/task/XUrlContainer.idl @@ -76,7 +76,7 @@ module com { module sun { module star { module task { //------------------------------------------------------------------------- /** Get all URLs. - @param OnlyPersistent Only URLs taht are stored persistently shall + @param OnlyPersistent Only URLs that are stored persistently shall be returned. @returns List of URLs. */ diff --git a/offapi/com/sun/star/task/makefile.mk b/offapi/com/sun/star/task/makefile.mk old mode 100755 new mode 100644 -- cgit