#96711# odk documentation

2 files changed, 40 insertions, 9 deletions

diff --git a/javaunohelper/com/sun/star/comp/helper/ComponentContext.java b/javaunohelper/com/sun/star/comp/helper/ComponentContext.java
index edf65bd19f25..663dc6caf97d 100644
--- a/javaunohelper/com/sun/star/comp/helper/ComponentContext.java
+++ b/javaunohelper/com/sun/star/comp/helper/ComponentContext.java
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: ComponentContext.java,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: dbo $ $Date: 2001-11-28 17:43:34 $
+ *  last change: $Author: dbo $ $Date: 2002-01-21 14:48:54 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -90,7 +90,9 @@ class Disposer implements XEventListener
         m_xComp.dispose();
     }
 }
-//==================================================================================================
+
+/** Component context implementation.
+*/
 public class ComponentContext implements XComponentContext, XComponent
 {
     private static final boolean DEBUG = false;
@@ -105,7 +107,15 @@ public class ComponentContext implements XComponentContext, XComponent
 
     private Vector m_eventListener;
 
-    //----------------------------------------------------------------------------------------------
+    /** Ctor to create a component context passing a hashtable for values and a delegator
+        reference. Entries of the passed hashtable are either direct values or
+        ComponentContextEntry objects.
+
+        @param table
+               entries
+        @param xDelegate
+               if values are not found, request is delegated to this object
+    */
     public ComponentContext( Hashtable table, XComponentContext xDelegate )
     {
         m_eventListener = new Vector();
diff --git a/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java b/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java
index 35bf552a3e6d..0a3940064f58 100644
--- a/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java
+++ b/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: ComponentContextEntry.java,v $
  *
- *  $Revision: 1.1 $
+ *  $Revision: 1.2 $
  *
- *  last change: $Author: dbo $ $Date: 2001-06-14 11:58:23 $
+ *  last change: $Author: dbo $ $Date: 2002-01-21 14:48:54 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -60,7 +60,16 @@
  ************************************************************************/
 package com.sun.star.comp.helper;
 
-//==================================================================================================
+/** Component context entry for constructing ComponentContext objects.
+    <p>
+    A ComponentContextEntry is separated into a late-init and direct-value
+    purpose.
+    The first one is commonly used for singleton objects of the component
+    context, that are raised on first-time retrieval of the key.
+    You have to pass a com.sun.star.lang.XSingleComponentFactory
+    or string (=> service name) object for this.
+    </p>
+*/
 public class ComponentContextEntry
 {
     /** if late init of service instance, set service name (String) or
@@ -71,13 +80,25 @@ public class ComponentContextEntry
     */
     public Object m_value;
 
-    //______________________________________________________________________________________________
+    /** Creating a late-init singleton entry component context entry.
+        The second parameter will be ignored and overwritten during
+        instanciation of the singleton instance.
+
+        @param lateInit
+               object factory or service string
+        @param value
+               pass null (dummy separating from second ctor signature)
+    */
     public ComponentContextEntry( Object lateInit, Object value )
     {
         this.m_lateInit = lateInit;
         this.m_value = value;
     }
-    //______________________________________________________________________________________________
+    /** Creating a direct value component context entry.
+
+        @param value
+               pass null
+    */
     public ComponentContextEntry( Object value )
     {
         this.m_lateInit = null;