#94968# IDL reviews merged

8 files changed, 112 insertions, 69 deletions

diff --git a/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl b/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl
index aad0f14ec076..33cfaeb378f9 100644
--- a/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl
+++ b/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: CannotRegisterImplementationException.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-19 16:15:28 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:08 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -73,11 +73,16 @@
 //=============================================================================
 
 // DocMerge from xml: exception com::sun::star::registry::CannotRegisterImplementationException
-/** is thrown when an application tries to register an implementation using the
+/** is thrown when an application tries to register a new component (implementation) using the
     <member>XImplementationRegistration::registerImplementation()</member>
-    method, but the component cannot be registered.
+    method, but the component cannot be registered. The reason for this exception could be:<br>
+    <br><ul>
+    <li>the component cannot be found or cannot be loaded (missing path or classpath)
+    <li>the component doesn't provide the necessary specifactions (exported registration functions for a
+    C++ component (shared library) or a named registration class with the appropriate methods for
+    a Java component (normally a jar file)).
+    </ul><br>
 
-    @see  XIdlReflection::forName
  */
 exception CannotRegisterImplementationException: com::sun::star::uno::Exception
 {
@@ -90,6 +95,12 @@ exception CannotRegisterImplementationException: com::sun::star::uno::Exception
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5.20.1  2002/03/26 14:24:17  jsc
+    #98365# reviewed
+
+    Revision 1.5  2000/12/19 16:15:28  mi
+    documentation syntax fixed
+
     Revision 1.4  2000/11/08 12:28:50  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/registry/ImplementationRegistration.idl b/udkapi/com/sun/star/registry/ImplementationRegistration.idl
index 1c409969dbc2..a8520ff8c230 100644
--- a/udkapi/com/sun/star/registry/ImplementationRegistration.idl
+++ b/udkapi/com/sun/star/registry/ImplementationRegistration.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: ImplementationRegistration.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:08 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -73,11 +73,10 @@
 //=============================================================================
 
 // DocMerge from xml: service com::sun::star::registry::ImplementationRegistration
-/** is the implementation of the interface XImplementationRegistration.
-    This service allows installation or deinstallation implementations. Further, it is
-    possible to check if all needed services are available to create a specified
-    implementation.
-
+/** is the implementation of the interface <type>XImplementationRegistration</type>.
+    This service can be used to install or uninstall components (implementations).
+    Further, it is possible to check if all runtime dependencies (needed services) are
+    available to use a specified component.
 
     Guarantees:
     <ul>
@@ -98,6 +97,12 @@ service ImplementationRegistration
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5.2.1  2002/03/26 14:24:17  jsc
+    #98365# reviewed
+
+    Revision 1.5  2001/11/16 15:05:59  mi
+    proofing by Richard Holt
+
     Revision 1.4  2000/11/08 12:28:50  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/registry/MergeConflictException.idl b/udkapi/com/sun/star/registry/MergeConflictException.idl
index e46d2d650328..de1e517b6602 100644
--- a/udkapi/com/sun/star/registry/MergeConflictException.idl
+++ b/udkapi/com/sun/star/registry/MergeConflictException.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: MergeConflictException.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: mi $ $Date: 2000-11-08 12:28:50 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:08 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -73,7 +73,8 @@
 //=============================================================================
 
 // DocMerge from xml: exception com::sun::star::registry::MergeConflictException
-/** is thrown if entries of two registries are contradictory.
+/** is thrown if entries of two registries are contradictory in the context of
+    <member>XSimpleRegistry::mergeKey()e</member> method.
  */
 exception MergeConflictException: com::sun::star::uno::Exception
 {
@@ -86,6 +87,12 @@ exception MergeConflictException: com::sun::star::uno::Exception
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.4.24.1  2002/03/26 14:24:17  jsc
+    #98365# reviewed
+
+    Revision 1.4  2000/11/08 12:28:50  mi
+    moved from api
+
     Revision 1.1.1.1  2000/09/18 23:35:32  hjs
     initial import
 
diff --git a/udkapi/com/sun/star/registry/NestedRegistry.idl b/udkapi/com/sun/star/registry/NestedRegistry.idl
index 8771ffa0e2b6..f23f103374b6 100644
--- a/udkapi/com/sun/star/registry/NestedRegistry.idl
+++ b/udkapi/com/sun/star/registry/NestedRegistry.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: NestedRegistry.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:09 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -114,7 +114,7 @@
     <br>
 
     </dt>
-    <dt>Functions of XRegistryKey:
+    <dt>Functions of <type>XRegistryKey</type>:
     <dl>
     <dt> <b>openKey</b>
     </dt>
@@ -153,31 +153,22 @@
     <b>Note: all write functions only work on registry1.</b>
     </dt>
     </dl>
-
-    <br>
-
     </dt>
-    <dt>How to initialize the registries:
-    <dl>
-    <dt> use a sequence of XSimpleRegistry with two elements. The first element must be
+    </dl>
+    <br>
+    How to initialize the registries:<br>
+    Use a sequence of <type>XSimpleRegistry</type> with two elements. The first element must be
     the registry which is opened with read/write rights and the second element must be
-    the read-only one.
-    </dt>
-    <dt> Two different ways are possible:
-    </dt>
-    <dd>
-    <dl>
-    <dt> use createInstanceWithArguments to create an instance of this service where the
-    value of the any parameter must be the sequence with the two open registries.
-    </dt>
-    <dt> use the initialize function of the XInitialization interface where the value of the
+    the read-only one.<br>
+    Two different ways are possible:<br>
+    <ul>
+    <li> use <member>com.sun.star.lang.XMultiServiceFactory::createInstanceWithArguments()</member> to
+    create an instance of this service where the value of the any parameter must be the sequence with
+    the two open registries.
+    <li> use the initialize function of the <type>XInitialization</type> interface where the value of the
     any parameter must be the sequence with the two open registries.
-    </dt>
-    </dl>
-    </dd>
-    </dl>
-    </dt>
-    </dl>
+    </ul>
+    <br>
 
 
     Guarantees:
@@ -201,6 +192,12 @@ service NestedRegistry
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.6.2.1  2002/03/26 14:24:17  jsc
+    #98365# reviewed
+
+    Revision 1.6  2001/11/16 15:05:59  mi
+    proofing by Richard Holt
+
     Revision 1.5  2000/12/19 14:17:15  mi
     documentation sytax fixed
 
diff --git a/udkapi/com/sun/star/registry/SimpleRegistry.idl b/udkapi/com/sun/star/registry/SimpleRegistry.idl
index 7a13ca5e0283..9d923d42084b 100644
--- a/udkapi/com/sun/star/registry/SimpleRegistry.idl
+++ b/udkapi/com/sun/star/registry/SimpleRegistry.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: SimpleRegistry.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: mi $ $Date: 2000-11-08 12:28:50 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:09 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -76,7 +76,6 @@
 /** makes it possible to create, open, or close a registry. Further, it is
     possible to merge a registry under a specified key in the open registry.
 
-
     Guarantees:
     <ul>
     <li>-thread safe</li>
@@ -96,6 +95,12 @@ service SimpleRegistry
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.4.24.1  2002/03/26 14:24:17  jsc
+    #98365# reviewed
+
+    Revision 1.4  2000/11/08 12:28:50  mi
+    moved from api
+
     Revision 1.1.1.1  2000/09/18 23:35:32  hjs
     initial import
 
diff --git a/udkapi/com/sun/star/registry/XImplementationRegistration.idl b/udkapi/com/sun/star/registry/XImplementationRegistration.idl
index 55e69ccd42fd..e56c272031a5 100644
--- a/udkapi/com/sun/star/registry/XImplementationRegistration.idl
+++ b/udkapi/com/sun/star/registry/XImplementationRegistration.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XImplementationRegistration.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:10 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -89,10 +89,14 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface
     //-------------------------------------------------------------------------
 
     // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::registerImplementation
-    /** registers one or more implementations.
+    /** registers a component which provides one or more implementations.
 
-        <p>The location of the implementation is specified with the URL.
-        </p>
+        @param aLocation
+            specifies the location of the component with the URL.
+
+        @param xReg
+            specifies the registry where the component should be installed. If it is a NULL interface
+            the component will be installed in the system registry.
      */
     void registerImplementation( [in] string aImplementationLoader,
              [in] string aLocation,
@@ -102,10 +106,14 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface
     //-------------------------------------------------------------------------
 
     // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::revokeImplementation
-    /** revokes one or more implementations from the registry.
+    /** revokes a component and all their provided implementations from the registry.
+
+        @param aLocation
+            specifies the location of the component with the URL.
 
-        <p>The location of the implementation is specified with the URL.
-        </p>
+        @param xReg
+            specifies the registry where the component should be installed. If it is a NULL interface
+            the component will be revoked from the system registry.
      */
     boolean revokeImplementation( [in] string aLocation,
              [in] com::sun::star::registry::XSimpleRegistry xReg );
@@ -115,15 +123,15 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface
 
     // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::getImplementations
     /** @returns
-                the names of the implementations registered by the url location.
+            the names of the implementations registered by the url location.
 
-                 @param aImplementationLoader
-                     specifies the name of the needed loader for this type of implementation. For
-                     example, the loader "com.sun.star.loader.SharedLibrary" for implementations
-                     that are realized as an SharedLibrary.
+        @param aImplementationLoader
+            specifies the name of the needed loader for this type of implementation. For
+            example, the loader "com.sun.star.loader.SharedLibrary" for implementations
+            that are realized as an SharedLibrary.
 
-                 @param aLocation
-                     specifies the location of the implementation.
+        @param aLocation
+            specifies the location of the component with the URL.
      */
     sequence<string> getImplementations( [in] string aImplementationLoader,
              [in] string aLocation );
@@ -133,7 +141,10 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface
 
     // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::checkInstantiation
     /** @returns
-                 a sequence with names of the missing services to create an instance of this implementation.
+             a sequence with names of the missing services to create an instance of this implementation.
+
+        @param implementationName
+            specifies the name of the checked implementation.
      */
     sequence<string> checkInstantiation( [in] string implementationName );
 
@@ -146,6 +157,12 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.6.2.1  2002/03/26 14:24:17  jsc
+    #98365# reviewed
+
+    Revision 1.6  2001/11/16 15:05:59  mi
+    proofing by Richard Holt
+
     Revision 1.5  2001/03/16 15:10:39  jsc
     remove interfaceheader with uik and remove [const] in method definitions
 
diff --git a/udkapi/com/sun/star/registry/XRegistryKey.idl b/udkapi/com/sun/star/registry/XRegistryKey.idl
index c818ac63491b..9160b1f208d1 100644
--- a/udkapi/com/sun/star/registry/XRegistryKey.idl
+++ b/udkapi/com/sun/star/registry/XRegistryKey.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XRegistryKey.idl,v $
  *
- *  $Revision: 1.7 $
+ *  $Revision: 1.8 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:11 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -92,9 +92,6 @@ module com { module sun { module star { module registry {
 
     <p>This is the main interface for registry keys.<p>
 
-    @version     0.1
-    @author      Juergen Schmidt
-
     @see XSimpleRegistry
 */
 interface XRegistryKey: com::sun::star::uno::XInterface
@@ -450,7 +447,7 @@ interface XRegistryKey: com::sun::star::uno::XInterface
             raises( com::sun::star::registry::InvalidRegistryException );
 
     //-------------------------------------------------------------------------
-    /** deletes a key from the registry.
+    /** deletes a link from the registry.
 
         @param aLinkName
         specifies the relative path from the current key to
@@ -466,7 +463,7 @@ interface XRegistryKey: com::sun::star::uno::XInterface
     //-------------------------------------------------------------------------
     // DOCUMENTATION CHANGED FOR XRegistryKey::getLinkTarget
     /** @returns
-        the target of the link specified by rLinkName.
+        the target (complete path of a key) of the link specified by rLinkName.
 
          @param rLinKName
         specifies the relative path from the current key to
diff --git a/udkapi/com/sun/star/registry/XSimpleRegistry.idl b/udkapi/com/sun/star/registry/XSimpleRegistry.idl
index 594fdebcdb34..bbb0578d0052 100644
--- a/udkapi/com/sun/star/registry/XSimpleRegistry.idl
+++ b/udkapi/com/sun/star/registry/XSimpleRegistry.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XSimpleRegistry.idl,v $
  *
- *  $Revision: 1.8 $
+ *  $Revision: 1.9 $
  *
- *  last change: $Author: jsc $ $Date: 2001-10-31 15:28:27 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:12 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -83,7 +83,11 @@
 module com { module sun { module star { module registry {
 
 //=============================================================================
-/**
+/** allows access to a registry (a persistent data source).
+    The data is stored in a hierarchical key structure beginning with a root key.
+    Each key can store a value and can have multiple subkeys.
+
+    @see XRegistryKey
 */
 interface XSimpleRegistry: com::sun::star::uno::XInterface
 {