ソースを参照

Added documentation to ctkServiceTracker.

Sascha Zelzer 14 年 前
コミット
631b8a5096
共有2 個のファイルを変更した12 個の追加6 個の削除を含む
  1. 9 3
      Libs/PluginFramework/ctkServiceTracker.h
  2. 3 3
      Libs/PluginFramework/ctkServiceTrackerPrivate.h

+ 9 - 3
Libs/PluginFramework/ctkServiceTracker.h

@@ -83,7 +83,9 @@ public:
    *        <code>ctkServiceTracker</code> will be used as the
    *        <code>ctkServiceTrackerCustomizer</code> and this
    *        <code>ctkServiceTracker</code> will call the
-   *        <code>ctkServiceTrackerCustomizer</code> methods on itself.
+   *        <code>ctkServiceTrackerCustomizer</code> methods on itself. If the
+   *        customizer is not <code>null</code>, this <code>ctkServiceTracker</code>
+   *        takes ownership of the customizer.
    */
   ctkServiceTracker(ctkPluginContext* context,
                     const ctkServiceReference& reference,
@@ -105,7 +107,9 @@ public:
    *        <code>ctkServiceTracker</code> will be used as the
    *        <code>ctkServiceTrackerCustomizer</code> and this
    *        <code>ctkServiceTracker</code> will call the
-   *        <code>ctkServiceTrackerCustomizer</code> methods on itself.
+   *        <code>ctkServiceTrackerCustomizer</code> methods on itself. If the
+   *        customizer is not <code>null</code>, this <code>ctkServiceTracker</code>
+   *        takes ownership of the customizer.
    */
   ctkServiceTracker(ctkPluginContext* context, const QString& clazz,
                         ctkServiceTrackerCustomizer* customizer = 0);
@@ -127,7 +131,9 @@ public:
    *        customizer is null, then this <code>ctkServiceTracker</code> will be
    *        used as the <code>ctkServiceTrackerCustomizer</code> and this
    *        <code>ctkServiceTracker</code> will call the
-   *        <code>ctkServiceTrackerCustomizer</code> methods on itself.
+   *        <code>ctkServiceTrackerCustomizer</code> methods on itself. If the
+   *        customizer is not <code>null</code>, this <code>ctkServiceTracker</code>
+   *        takes ownership of the customizer.
    */
   ctkServiceTracker(ctkPluginContext* context, const ctkLDAPSearchFilter& filter,
                         ctkServiceTrackerCustomizer* customizer = 0);

+ 3 - 3
Libs/PluginFramework/ctkServiceTrackerPrivate.h

@@ -108,14 +108,14 @@ public:
 
   /**
    * Tracked services: <code>ctkServiceReference</code> -> customized Object and
-   * <code>ServiceListener</code> object
+   * <code>ctkServiceSlotEntry</code> object
    */
   QSharedPointer<ctkTrackedService> trackedService;
 
   /**
-   * Accessor method for the current Tracked object. This method is only
+   * Accessor method for the current ctkTrackedService object. This method is only
    * intended to be used by the unsynchronized methods which do not modify the
-   * tracked field.
+   * trackedService field.
    *
    * @return The current Tracked object.
    */