#96764# documentation review

javaunohelper/com/sun/star/comp/helper/Bootstrap.java

@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Bootstrap.java,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: dbo $ $Date: 2001-11-28 17:43:34 $
+ *  last change: $Author: jl $ $Date: 2002-01-22 10:49:27 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -79,7 +79,26 @@ import com.sun.star.uno.UnoRuntime;
 
 import java.util.Hashtable;
 
+/** Bootstrap offers functionality to obtain a context or simply
+    a service manager.
+    The service manager can create a few basic services, whose implementations  are:
+    <ul>
+    <li>com.sun.star.comp.loader.JavaLoader</li>
+    <li>com.sun.star.comp.urlresolver.UrlResolver</li>
+    <li>com.sun.star.comp.bridgefactory.BridgeFactory</li>
+    <li>com.sun.star.comp.connections.Connector</li>
+    <li>com.sun.star.comp.connections.Acceptor</li>
+    <li>com.sun.star.comp.servicemanager.ServiceManager</li>
+    </ul>
 
+    Other services can be inserted into the service manager by
+    using its XSet interface:
+    <pre>
+        XSet xSet = (XSet)UnoRuntime.queryInterface( XSet.class, aMultiComponentFactory );
+        // insert the service manager
+        xSet.insert( aSingleComponentFactory );
+    </pre>
+*/
 public class Bootstrap {
 
     private static void insertBasicFactories(
@@ -109,6 +128,9 @@ public class Bootstrap {
 
     /** Bootstraps an initial component context with service manager and basic
         jurt components inserted.
+        @param context_entries the hash table contains mappings of entry names (type string) to
+        context entries (type class ComponentContextEntry).
+        @return a new context.
     */
     static public XComponentContext createInitialComponentContext( Hashtable context_entries )
         throws Exception

javaunohelper/com/sun/star/comp/helper/RegistryServiceFactory.java

@@ -2,9 +2,9 @@
  *
  *  $RCSfile: RegistryServiceFactory.java,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: jsc $ $Date: 2001-08-02 12:12:59 $
+ *  last change: $Author: jl $ $Date: 2002-01-22 10:50:35 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -67,7 +67,9 @@ import com.sun.star.lang.XMultiServiceFactory;
 import com.sun.star.uno.UnoRuntime;
 import com.sun.star.uno.RuntimeException;
 
-
+/** The class provides a set of methods which create instances of the
+    com.sun.star.lang.RegistryServiceManager service.
+*/
 public class RegistryServiceFactory {
     static {
         System.loadLibrary("juh");
@@ -89,8 +91,7 @@ public class RegistryServiceFactory {
       *                             file will be created if necessary.
       * @param readRegistryFile     file name of the second registry file of the nested registry
       *                             which will be opened with readonly rights.
-      *
+     * @return a new RegistryServiceFactory.
-      * @author Markus Herzog
       */
     public static XMultiServiceFactory create(String writeRegistryFile, String readRegistryFile)
         throws com.sun.star.uno.Exception
@@ -113,7 +114,7 @@ public class RegistryServiceFactory {
      *                              readonly rights. Default is FALSE. If this flag is used the registry
      *                              will not be created if not exist.
      *
-      * @author Markus Herzog
+      * @return a new RegistryServiceFactory
       */
     public static XMultiServiceFactory create(String writeRegistryFile, String readRegistryFile, boolean readOnly)
         throws com.sun.star.uno.Exception
@@ -159,7 +160,7 @@ public class RegistryServiceFactory {
      * @param registryFile          file name of the registry to use/ create; if this is an empty
      *                              string, the default registry is used instead
      *
-     * @author Markus Herzog
+     * @return a new RegistryServiceFactory.
      */
     public static XMultiServiceFactory create(String registryFile)
         throws com.sun.star.uno.Exception
@@ -176,7 +177,7 @@ public class RegistryServiceFactory {
      *                              readonly rights. Default is FALSE. If this flag is used the registry
      *                              will not be created if not exist.
      *
-     * @author Markus Herzog
+     * @return a new RegistryServiceFactory.
      */
     public static XMultiServiceFactory create(String registryFile, boolean readOnly)
         throws com.sun.star.uno.Exception
@@ -185,9 +186,9 @@ public class RegistryServiceFactory {
     }
 
     /**
-     * This bootstraps a service factory without initilaize a registry.
+     * This bootstraps a service factory without initialize a registry.
      *<BR>
-     * @author Markus Herzog
+     * @return a new RegistryServiceFactory.
      */
     public static XMultiServiceFactory create() throws com.sun.star.uno.Exception {
         return create( null, null, false );

javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java

@@ -2,9 +2,9 @@
  *
  *  $RCSfile: SharedLibraryLoader.java,v $
  *
- *  $Revision: 1.1.1.1 $
+ *  $Revision: 1.2 $
  *
- *  last change: $Author: hr $ $Date: 2000-09-18 16:31:32 $
+ *  last change: $Author: jl $ $Date: 2002-01-22 10:52:07 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -69,8 +69,6 @@ import com.sun.star.registry.XRegistryKey;
  * The <code>SharedLibraryLoader</code> class provides the functionality of the <code>com.sun.star.loader.SharedLibrary</code>
  * service.
  * <p>
- * @version     $Revision: 1.1.1.1 $ $ $Date: 2000-09-18 16:31:32 $
- * @author      Markus Herzog
  * @see         com.sun.star.loader.SharedLibrary
  * @see         com.sun.star.comp.servicemanager.ServiceManager
  * @see         com.sun.star.lang.ServiceManager