#94968# IDL reviews merged

5 files changed, 97 insertions, 36 deletions

diff --git a/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl b/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl
index 9cc33581d5e5..4f20553b2ea1 100644
--- a/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl
+++ b/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: CannotActivateFactoryException.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 14:58:45 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -71,10 +71,16 @@
 
 //=============================================================================
 
-// DocMerge from xml: exception com::sun::star::loader::CannotActivateFactoryException
-/** is thrown when an application tries to activate a component factory using the
+/** indicates an error during component activation
+    <p> This exception is thrown when an application tries to
+    activate a component factory using the
     <member>XImplementationLoader::activate()</member>
     method, but the component factory can not be activated.
+    <p>
+    Possible reasons for this error is a missing shared library or .jar file,
+    a badly linked library, a wrong LD_LIBRARY_PATH or PATH, an incomplete
+    classpath, or a missing java installation. The Message should
+    contain some more detailed explanations.
  */
 exception CannotActivateFactoryException: com::sun::star::uno::Exception
 {
@@ -87,6 +93,12 @@ exception CannotActivateFactoryException: com::sun::star::uno::Exception
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5.2.1  2002/06/05 16:38:41  jbu
+    documentation reviewed
+
+    Revision 1.5  2001/11/16 14:58:45  mi
+    proofing by Richard Holt
+
     Revision 1.4  2000/11/08 12:28:45  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/loader/Dynamic.idl b/udkapi/com/sun/star/loader/Dynamic.idl
index d8895884dfaf..3b5258220910 100644
--- a/udkapi/com/sun/star/loader/Dynamic.idl
+++ b/udkapi/com/sun/star/loader/Dynamic.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Dynamic.idl,v $
  *
- *  $Revision: 1.3 $
+ *  $Revision: 1.4 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 14:58:45 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -71,7 +71,8 @@ interface XImplementationLoader;
 
 
 /** makes it possible to access services accessible via a <code>UnoUrlResolver</code>
-    E.g., instantiation of services in another process
+    E.g., instantiation of services in another process. This service is still in an
+    experimental state and should not be used in a production environment.
  */
 service Dynamic
 {
@@ -89,8 +90,7 @@ service Dynamic
     interface XImplementationLoader;
 
 
-    /** provides additional information about the implementations
-        and the services supported by them.
+    /** gives information about other supported services
      */
     interface com::sun::star::lang::XServiceInfo;
 };
diff --git a/udkapi/com/sun/star/loader/Java.idl b/udkapi/com/sun/star/loader/Java.idl
index 30f6cb2df196..baf98575b524 100644
--- a/udkapi/com/sun/star/loader/Java.idl
+++ b/udkapi/com/sun/star/loader/Java.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Java.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: mi $ $Date: 2000-11-08 12:28:45 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -71,21 +71,19 @@ interface XImplementationLoader;
 
 
 // DocMerge from xml: service com::sun::star::loader::Java
-/** makes it possible to access the services implemented in a Java class file.
+/** allows to access a java component stored with a .jar file
  */
 service Java
 {
 
-    // DocMerge from xml: service com::sun::star::loader::Java: interface com::sun::star::loader::XImplementationLoader
     /** is used for writing persistent information in the registry for
-                external implementation and for activating this implementation.
+                external implementation and for activating this implementation. The
+                locationUrls must be absolute file urls.
      */
     interface XImplementationLoader;
 
 
-    // DocMerge from xml: service com::sun::star::loader::Java: interface com::sun::star::lang::XServiceInfo
-    /** provides additional information about the implementations
-                and the services supported by them.
+    /** gives information about other supported services
      */
     interface com::sun::star::lang::XServiceInfo;
 };
@@ -98,6 +96,12 @@ service Java
       Source Code Control System - Update
 
       $Log: not supported by cvs2svn $
+      Revision 1.4.24.1  2002/06/05 16:38:41  jbu
+      documentation reviewed
+
+      Revision 1.4  2000/11/08 12:28:45  mi
+      moved from api
+
       Revision 1.1.1.1  2000/09/18 23:35:27  hjs
       initial import
 
diff --git a/udkapi/com/sun/star/loader/SharedLibrary.idl b/udkapi/com/sun/star/loader/SharedLibrary.idl
index 26f5390a572b..b28f6e075851 100644
--- a/udkapi/com/sun/star/loader/SharedLibrary.idl
+++ b/udkapi/com/sun/star/loader/SharedLibrary.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: SharedLibrary.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: mi $ $Date: 2000-11-08 12:28:45 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -70,13 +70,11 @@
 interface XImplementationLoader;
 
 
-// DocMerge from xml: service com::sun::star::loader::SharedLibrary
-/** makes it possible to access the services implemented in a shared library.
+/** allows to access a native component stored in a shared library.
  */
 service SharedLibrary
 {
 
-    // DocMerge from xml: service com::sun::star::loader::SharedLibrary: interface com::sun::star::loader::XImplementationLoader
     /** is used for writing persistent information in the registry for
                 an external implementation and for activating this
                 implementation.
@@ -84,9 +82,7 @@ service SharedLibrary
     interface XImplementationLoader;
 
 
-    // DocMerge from xml: service com::sun::star::loader::SharedLibrary: interface com::sun::star::lang::XServiceInfo
-    /** provides additional information about the implementations
-                and the services supported by them.
+    /** gives information about other supported services
      */
     interface com::sun::star::lang::XServiceInfo;
 };
@@ -98,6 +94,12 @@ service SharedLibrary
       Source Code Control System - Update
 
       $Log: not supported by cvs2svn $
+      Revision 1.4.24.1  2002/06/05 16:38:41  jbu
+      documentation reviewed
+
+      Revision 1.4  2000/11/08 12:28:45  mi
+      moved from api
+
       Revision 1.2  2000/10/09 14:24:57  mi
       #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
 
diff --git a/udkapi/com/sun/star/loader/XImplementationLoader.idl b/udkapi/com/sun/star/loader/XImplementationLoader.idl
index 884e95bd18a8..9a16c7f03e5d 100644
--- a/udkapi/com/sun/star/loader/XImplementationLoader.idl
+++ b/udkapi/com/sun/star/loader/XImplementationLoader.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XImplementationLoader.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -83,15 +83,40 @@
 
 //=============================================================================
 
-// DocMerge from xml: interface com::sun::star::loader::XImplementationLoader
-/** defines the interface for classes that manage all the work needed to instantiate an implementation.@see     XImplementationRegistration
+/** handles activation (loading) of a UNO component.
+    @see        com::sun::star::registry::XImplementationRegistration
  */
 interface XImplementationLoader: com::sun::star::uno::XInterface
 {
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::loader::XImplementationLoader::activate
-    /** activates an external service factory.
+    /** activates a concrete implementation within a component.
+        @param implementationName The name of the implementation,
+               which shall be instantiated. The method
+               <member>XImplementationLoader::writeRegistryInfo</member>
+               writes a list of implementation names hosted by this component.
+        @param implementationLoaderUrl specification bug, ignore this parameter, please
+               pass an empty string.
+        @param locationUrl Points to the location of the file containing
+               the component (for instance a .jar-file or a shared library).
+               This parameter
+               should be in an URL format (= protocol:protocol-dependent-part).
+               In case the string contains no
+               leading "protocol:", the implementation in general assumes,
+               that it is a relative file url. <p>Special loaders may define
+               their own protocol (for instance an executable loader may need
+               more than only one file url).
+
+        @param xKey A registry which may be used to read static data previously
+               written via <method>XImplementationLoader::writeRegistryInfo()</method>.
+               The use of this parameter is deprecated.
+
+        @return returns a factory interface, which allows to create an instance of
+                the concrete implementation. In general, the object supports a
+                <type>com::sun::star::lang::XSingleComponentFactory</type>
+                and the <type>com::sun::star::lang::XServiceInfo</type> interface. The
+                XServiceInfo interface informs about the capabilities of the
+                service implementation, not the factory itself.
      */
     com::sun::star::uno::XInterface activate( [in] string implementationName,
              [in] string implementationLoaderUrl,
@@ -100,11 +125,23 @@ interface XImplementationLoader: com::sun::star::uno::XInterface
             raises( com::sun::star::loader::CannotActivateFactoryException );
 
     //-------------------------------------------------------------------------
-
-    // DocMerge from xml: method com::sun::star::loader::XImplementationLoader::writeRegistryInfo
-    /** writes information about implementations in the registry. An implementation supports one or more services. This
-        and more information will be written in the registry. This function is called when an implementation
-        is registered.@see com::sun::star::repos::XImplementationRegistration
+    /** writes a list of all implementations hosted by this component into a registry key.
+        <p>This method is called during registering a component.
+        @param xKey The registry key, which shall be used to write for each
+                    implementation the implementation name plus a list of supported
+                    services.
+        @param implementationLoaderUrl specification bug, ignore this parameter, please
+               pass an empty string.
+        @param locationUrl Points to the location of the file containing
+               the component (for instance a .jar-file or a shared library).
+               This parameter
+               should be in an URL format (= protocol:protocol-dependent-part).
+               In case the string contains no
+               leading &quot;protocol:&quot;, the implementation in general assumes,
+               that it is a relative file url. <p>Special loaders may define
+               their own protocol (for instance an executable loader may need
+               more than only one file url).
+        @see com::sun::star::registry::XImplementationRegistration
      */
     boolean writeRegistryInfo( [in] com::sun::star::registry::XRegistryKey xKey,
              [in] string implementationLoaderUrl,
@@ -120,6 +157,12 @@ interface XImplementationLoader: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5.16.1  2002/06/05 16:38:41  jbu
+    documentation reviewed
+
+    Revision 1.5  2001/03/16 15:10:38  jsc
+    remove interfaceheader with uik and remove [const] in method definitions
+
     Revision 1.4  2000/11/08 12:28:45  mi
     moved from api