API documentation

1 files changed, 38 insertions, 2 deletions

diff --git a/cppuhelper/inc/cppuhelper/implbase3.hxx b/cppuhelper/inc/cppuhelper/implbase3.hxx
index 939f02c838a4..830120bc8eae 100644
--- a/cppuhelper/inc/cppuhelper/implbase3.hxx
+++ b/cppuhelper/inc/cppuhelper/implbase3.hxx
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: implbase3.hxx,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: dbo $ $Date: 2001-03-15 15:47:29 $
+ *  last change: $Author: dbo $ $Date: 2001-05-14 11:58:06 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -83,6 +83,16 @@ namespace cppu
             : ClassDataBase( nClassCode )
             {}
     };
+    /** This template class serves as a base class for all subsequent implementation helper classes.
+        It inherits from given interfaces (template parameters) and com.sun.star.lang.XTypeProvider.
+
+        Do not use this class directly, use
+               ImplHelperBaseN<>,
+               WeakImplHelperN<>,
+               WeakAggImplHelperN<>
+               WeakComponentImplHelperN<>,
+               WeakAggComponentImplHelperN<>.
+    */
     template< class Ifc1, class Ifc2, class Ifc3 >
     class ImplHelperBase3
         : public ::com::sun::star::lang::XTypeProvider
@@ -110,6 +120,14 @@ namespace cppu
                 return rCD;
             }
     };
+    /** This template class inherits from ImplHelperBaseN<> and implements
+        com.sun.star.uno.XInterface::queryInterface() and the com.sun.star.lang.XTypeProvider
+        interface.
+
+        All other virtual functions (inherited from given template parameter interfaces)
+        have to be implemented by sub-classing from the templated class, e.g.
+        class MyImpl : public ::cppu::ImplHelperN<> { ... };
+    */
     template< class Ifc1, class Ifc2, class Ifc3 >
     class ImplHelper3
         : public ImplHelperBase3< Ifc1, Ifc2, Ifc3 >
@@ -123,6 +141,15 @@ namespace cppu
         virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException)
             { return getClassData( s_aCD ).getImplementationId(); }
     };
+    /** This template class inherits from ::cppu::ImplHelperBaseN<> and ::cppu::OWeakObject,
+        thus delegating life-cycle to that implementation.
+        Use this helper implementing an object, that can be held weakly, using the
+        ::cppu::WeakReference<> template class.
+
+        All other virtual functions (inherited from given template parameter interfaces)
+        have to be implemented by sub-classing from the templated class, e.g.
+        class MyImpl : public ::cppu::WeakImplHelperN<> { ... };
+    */
     template< class Ifc1, class Ifc2, class Ifc3 >
     class WeakImplHelper3
         : public ::cppu::OWeakObject
@@ -144,6 +171,15 @@ namespace cppu
         virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException)
             { return getClassData( s_aCD ).getImplementationId(); }
     };
+    /** This template class inherits from ::cppu::ImplHelperBaseN<> and ::cppu::OWeakAggObject,
+        thus delegating life-cycle to that implementation.
+        Use this helper implementing an object, that can be held weakly using the
+        ::cppu::WeakReference<> template class and can be aggregated by other objects.
+
+        All other virtual functions (inherited from given template parameter interfaces)
+        have to be implemented by sub-classing from the templated class, e.g.
+        class MyImpl : public ::cppu::WeakAggImplHelperN<> { ... };
+    */
     template< class Ifc1, class Ifc2, class Ifc3 >
     class WeakAggImplHelper3
         : public ::cppu::OWeakAggObject