proofing by Richard Holt

12 files changed, 70 insertions, 59 deletions

diff --git a/udkapi/com/sun/star/bridge/BridgeFactory.idl b/udkapi/com/sun/star/bridge/BridgeFactory.idl
index dc8d6a16b04d..fe4728594de4 100644
--- a/udkapi/com/sun/star/bridge/BridgeFactory.idl
+++ b/udkapi/com/sun/star/bridge/BridgeFactory.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: BridgeFactory.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:24:19 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -78,7 +78,7 @@
 /** allows to create new or access existing interprocess bridges.
 
     <p> It enumerates at the servicemanager all services supporting
-    the meta service com.sun.star.bridge.Bridge to get to know possible
+    the meta service com.sun.star.bridge.Bridge to get all known, possible
     protocols.
 
     @see com::sun::star::bridge::Bridge
diff --git a/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl b/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl
index 1e19ed43451e..c6f0fd1d32d0 100644
--- a/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl
+++ b/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: OleApplicationRegistration.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:24:19 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -76,7 +76,7 @@
 /** registers standard UNO objects to OLE Automation.
 
     <p>It does not provide any specific interface because the UNO object
-    is registered while instanciating this service and deregistered
+    is registered while instantiating this service and deregistered
     if the implementation is released.  </p>
 
     <p> The following UNO objects are provided: </p>
@@ -99,6 +99,9 @@ service OleApplicationRegistration
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:40  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:26  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/bridge/XBridge.idl b/udkapi/com/sun/star/bridge/XBridge.idl
index 013081e0f022..7f86f315cfcd 100644
--- a/udkapi/com/sun/star/bridge/XBridge.idl
+++ b/udkapi/com/sun/star/bridge/XBridge.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XBridge.idl,v $
  *
- *  $Revision: 1.7 $
+ *  $Revision: 1.8 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:24:19 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -85,7 +85,7 @@ interface XBridge: com::sun::star::uno::XInterface
 
 
     // DocMerge from xml: method com::sun::star::bridge::XBridge::getName
-    /** name that got the bridge when it was created.
+    /** name that the bridge got when it was created.
      */
     string getName();
 
diff --git a/udkapi/com/sun/star/bridge/XBridgeFactory.idl b/udkapi/com/sun/star/bridge/XBridgeFactory.idl
index eed21d45200c..c03b84f6808e 100644
--- a/udkapi/com/sun/star/bridge/XBridgeFactory.idl
+++ b/udkapi/com/sun/star/bridge/XBridgeFactory.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XBridgeFactory.idl,v $
  *
- *  $Revision: 1.8 $
+ *  $Revision: 1.9 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:24:19 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -84,7 +84,7 @@ interface XBridgeFactory: com::sun::star::uno::XInterface
              getBridge(). No BridgeExistsException can be thrown in this case.
 
         @param sProtocol
-            The protocol, that will be used on the connection (e.g. urp) plus additional
+            The protocol, that will be used on the connection (e.g., urp) plus additional
             comma separated name=value protocol properties.
 
         @param aConnection
diff --git a/udkapi/com/sun/star/bridge/XInstanceProvider.idl b/udkapi/com/sun/star/bridge/XInstanceProvider.idl
index 453670bcf151..e89e832ac304 100644
--- a/udkapi/com/sun/star/bridge/XInstanceProvider.idl
+++ b/udkapi/com/sun/star/bridge/XInstanceProvider.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XInstanceProvider.idl,v $
  *
- *  $Revision: 1.7 $
+ *  $Revision: 1.8 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:24:19 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -80,7 +80,7 @@ interface XInstanceProvider: com::sun::star::uno::XInterface
             The name of the requested object.
 
        @returns
-            the object associated with the name. The return value maybe null in case
+            the object associated with the name. The return value may be null in case
             there is no object to offer for this string. In this case, XBridge.getInstance()
             will also return a null reference
 
diff --git a/udkapi/com/sun/star/bridge/XProtocolProperties.idl b/udkapi/com/sun/star/bridge/XProtocolProperties.idl
index 1c65dde4cb3a..fa1015bb981c 100644
--- a/udkapi/com/sun/star/bridge/XProtocolProperties.idl
+++ b/udkapi/com/sun/star/bridge/XProtocolProperties.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XProtocolProperties.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: jsc $ $Date: 2001-03-16 15:10:33 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:24:19 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -77,7 +77,7 @@ module com { module sun { module star { module bridge {
 interface XProtocolProperties : com::sun::star::uno::XInterface
 {
     /** called to get a list of bridge internal properties. Which properties can be retrieved,
-        is protocol dependend.
+        is protocol dependent.
 
         <p> The properties MUST NOT change between a requestChange and a commit change call.</p>
      */
diff --git a/udkapi/com/sun/star/connection/Acceptor.idl b/udkapi/com/sun/star/connection/Acceptor.idl
index d9c372eabff4..6b675d034ffb 100644
--- a/udkapi/com/sun/star/connection/Acceptor.idl
+++ b/udkapi/com/sun/star/connection/Acceptor.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Acceptor.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:25:39 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -73,9 +73,9 @@
 
 /** allows to accept connection attempts from another process.
     <p>
-    Acceptor is a delagating service. You can add further acceptors by giving
+    Acceptor is a delegating service. You can add further acceptors by giving
     them a service name com.sun.star.connection.Acceptor.xxx, where xxx is the
-    connection type used int the connection string during accept()/connect() call.
+    connection type used in the connection string during accept()/connect() call.
 
  */
 service Acceptor
diff --git a/udkapi/com/sun/star/connection/ConnectionSetupException.idl b/udkapi/com/sun/star/connection/ConnectionSetupException.idl
index d9f0bee7553f..8c442799b28d 100644
--- a/udkapi/com/sun/star/connection/ConnectionSetupException.idl
+++ b/udkapi/com/sun/star/connection/ConnectionSetupException.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: ConnectionSetupException.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:25:39 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -64,7 +64,7 @@
 
  module com {  module sun {  module star {  module connection {
 
-/** Is e.g. thrown, when it is not possible to accept on a local resource.
+/** Is thrown, when it is not possible to accept on a local resource.
  */
 exception ConnectionSetupException: com::sun::star::uno::Exception
 {
diff --git a/udkapi/com/sun/star/connection/Connector.idl b/udkapi/com/sun/star/connection/Connector.idl
index f0656b4262ed..10f0a4cb5a31 100644
--- a/udkapi/com/sun/star/connection/Connector.idl
+++ b/udkapi/com/sun/star/connection/Connector.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Connector.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:25:39 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -73,9 +73,9 @@
 
 /** allows to establish a connection to another process.
     <p>
-    Connector is a delagating service. You can add further connectors by giving
+    Connector is a delegating service. You can add further connectors by giving
     them a service name com.sun.star.connection.Connector.xxx, where xxx is the
-    connection type used int the connection string during accept()/connect() call.
+    connection type used in the connection string during accept()/connect() call.
  */
 service Connector
 {
diff --git a/udkapi/com/sun/star/connection/XAcceptor.idl b/udkapi/com/sun/star/connection/XAcceptor.idl
index 81a6c6be856e..5e5eae2c1d75 100644
--- a/udkapi/com/sun/star/connection/XAcceptor.idl
+++ b/udkapi/com/sun/star/connection/XAcceptor.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XAcceptor.idl,v $
  *
- *  $Revision: 1.8 $
+ *  $Revision: 1.9 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:25:39 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -69,7 +69,7 @@
 
 module com {  module sun {  module star {  module connection {
 
-/** allows to passivly accept connection attempts from other processes.
+/** allows to passively accept connection attempts from other processes.
 
     <p>
     This is the counterpart to the XConnector interface.
@@ -83,16 +83,20 @@ interface XAcceptor: com::sun::star::uno::XInterface
         further connections, but the parameter string MUST be left unchanged.
 
 
-       @param sConnectionDescription contains the kind of the connection plus a
-              comma seperated list of attributes.
-              e.g. <em>socket,host=locahost,port=2345</em> for a tcpip connection.
+       @param sConnectionDescription
+                contains the kind of the connection plus a
+              comma seperated list of attributes,
+               e.g., <em>socket,host=locahost,port=2345</em> for a tcpip connection.
 
-       @return null reference, stopAccepting was called. Otherwise a valid XConnection
-               reference.
+       @return null reference,
+            stopAccepting was called.
+            Otherwise a valid XConnection reference.
 
-       @throws AlreadyAcceptingException Only one acceptor-thread per instance allowed.
-       @throws ConnectionSetupException  Problems during setting up the acceptor.
-                                         (e.g. Security-reasons, socket already busy, etc. )
+       @throws AlreadyAcceptingException
+                Only one acceptor-thread per instance allowed.
+       @throws ConnectionSetupException
+            Problems during setting up the acceptor.
+          (e.g., Security-reasons, socket already busy, etc.)
        @throws com::sun::star::lang::IllegalArgumentException
                   sConnectionDescription could not be interpreted
 
diff --git a/udkapi/com/sun/star/connection/XConnection.idl b/udkapi/com/sun/star/connection/XConnection.idl
index 450585bfb801..cec065f48ac6 100644
--- a/udkapi/com/sun/star/connection/XConnection.idl
+++ b/udkapi/com/sun/star/connection/XConnection.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XConnection.idl,v $
  *
- *  $Revision: 1.8 $
+ *  $Revision: 1.9 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:25:39 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -76,19 +76,20 @@ interface XConnection: com::sun::star::uno::XInterface
 {
 
     /** reads a requested number of bytes from the connection.
-        <p> This method is blocking, meaning that it  always returns a bytesequence
-        with the requested number of bytes unless it has reached end of file (which
+        <p> This method is blocking, meaning that it always returns a bytesequence
+        with the requested number of bytes, unless it has reached end of file (which
         often means, that close() has been called).
 
         <p> please see also the readSomeBytes() method of XConnection2.
 
-        @return The read number of bytes. The return value and the length of the
+        @return The read number of bytes.
+                The return value and the length of the
                 returned sequence must be identical.
         @param nBytesToRead
                 The number of bytes to be read from the stream.
 
         @throws com::sun::star::io::IOException
-               in case an error occured during reading from the stream.
+               in case an error occurred during reading from the stream.
      */
     long read( [out] sequence < byte > aReadBytes , [in] long nBytesToRead )
             raises( com::sun::star::io::IOException );
@@ -99,7 +100,7 @@ interface XConnection: com::sun::star::uno::XInterface
         <p>The method blocks until the whole sequence is written.
 
         @throws com::sun::star::io::IOException
-               in case an error occured during writing to the stream.
+               in case an error occurred during writing to the stream.
      */
     void write( [in] sequence < byte > aData )
         raises( com::sun::star::io::IOException );
@@ -110,7 +111,7 @@ interface XConnection: com::sun::star::uno::XInterface
     void flush( )
             raises( com::sun::star::io::IOException );
 
-    /** Immeadiatly terminates any ongoing read or write calls.
+    /** Immediately terminates any ongoing read or write calls.
         All subsequent read or write calls()
      */
     void close( )
diff --git a/udkapi/com/sun/star/connection/XConnector.idl b/udkapi/com/sun/star/connection/XConnector.idl
index 61c53121c276..5502d84ff8a1 100644
--- a/udkapi/com/sun/star/connection/XConnector.idl
+++ b/udkapi/com/sun/star/connection/XConnector.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XConnector.idl,v $
  *
- *  $Revision: 1.8 $
+ *  $Revision: 1.9 $
  *
- *  last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $
+ *  last change: $Author: mi $ $Date: 2001-11-16 14:25:39 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -70,7 +70,7 @@
 module com {  module sun {  module star {  module connection {
 
 /**
-   allows to activly establish an interprocess connection.
+   allows to actively establish an interprocess connection.
  */
 interface XConnector: com::sun::star::uno::XInterface
 {
@@ -80,16 +80,19 @@ interface XConnector: com::sun::star::uno::XInterface
         <p>
         Tries to connect to an <type>XAcceptor</type>.
 
-        @param sConnectionDescription contains the kind of the connection plus a
-               comma seperated list of attributes.
-               e.g. <em>socket,host=locahost,port=2345</em> for a tcpip connection.
+        @param sConnectionDescription
+                contains the kind of the connection plus a
+                comma seperated list of attributes,
+               e.g., <em>socket,host=locahost,port=2345</em> for a tcpip connection.
 
-        @throws ConnectionSetupException  Problems during setting up the connector
-                on client side(e.g. Security-reasons, socket already busy .. ), or the
-                string could not be interpreted correctly.
+        @throws ConnectionSetupException
+                Problems during setting up the connector
+              on client side, (e.g., Security-reasons, socket already busy .. ),
+                or the string could not be interpreted correctly.
 
-        @throws NoConnectException     Couldn't reach a server (e.g. network failure), no server
-                                       is listening
+        @throws NoConnectException
+                Couldn't reach a server (e.g. network failure),
+                no server is listening
      */
     XConnection connect( [in] string sConnectionDescription )
         raises( NoConnectException,ConnectionSetupException );