Merge pull request #1165 from yue9944882/doc/informer-factory

k8s-ci-robot · web-flow · commit 65dc680a51ef · 2020-08-18T08:17:30.000-07:00
Doc: Fixes the gap between doc &amp; impl for informer factory
diff --git a/util/src/main/java/io/kubernetes/client/informer/SharedInformerFactory.java b/util/src/main/java/io/kubernetes/client/informer/SharedInformerFactory.java
@@ -95,8 +95,8 @@ SharedIndexInformer<ApiType> sharedIndexInformerFor(
   }
 
   /**
-   * Constructs and returns a shared index informer w/ resync period specified. And the informer
-   * cache will be overwritten.
+   * Constructs and returns a shared index informer w/ resync period specified. But the informer
+   * cache will not be overwritten i.e. only the first registered informer will be kept.
    *
    * @param <ApiType> the type parameter
    * @param <ApiListType> the type parameter
@@ -118,8 +118,9 @@ SharedIndexInformer<ApiType> sharedIndexInformerFor(
   }
 
   /**
-   * Constructs and returns a shared index informer by specifying lister-watcher. And the informer
-   * cache will be overwritten on multiple call w/ the the same apiTypeClass.
+   * Constructs and returns a shared index informer by specifying lister-watcher. But the informer
+   * cache will not be overwritten on multiple call w/ the the same apiTypeClass i.e. only the first
+   * registered informer will be kept.
    *
    * @param <ApiType> the type parameter
    * @param <ApiListType> the type parameter

Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,8 @@ SharedIndexInformer<ApiType> sharedIndexInformerFor(`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
`98`		`- * Constructs and returns a shared index informer w/ resync period specified. And the informer`
`99`		`- * cache will be overwritten.`
	`98`	`+ * Constructs and returns a shared index informer w/ resync period specified. But the informer`
	`99`	`+ * cache will not be overwritten i.e. only the first registered informer will be kept.`
`100`	`100`	`*`
`101`	`101`	`* @param <ApiType> the type parameter`
`102`	`102`	`* @param <ApiListType> the type parameter`
`@@ -118,8 +118,9 @@ SharedIndexInformer<ApiType> sharedIndexInformerFor(`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`/**`
`121`		`- * Constructs and returns a shared index informer by specifying lister-watcher. And the informer`
`122`		`- * cache will be overwritten on multiple call w/ the the same apiTypeClass.`
	`121`	`+ * Constructs and returns a shared index informer by specifying lister-watcher. But the informer`
	`122`	`+ * cache will not be overwritten on multiple call w/ the the same apiTypeClass i.e. only the first`
	`123`	`+ * registered informer will be kept.`
`123`	`124`	`*`
`124`	`125`	`* @param <ApiType> the type parameter`
`125`	`126`	`* @param <ApiListType> the type parameter`