MINOR Documentation (from r104769)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@112380 467b73ca-7a2a-4603-9d3b-597d59a354a9
silverstripe · Oct 15, 2010 · 5dc8b97 · 5dc8b97
1 parent 0b6feff
commit 5dc8b97
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/core/model/DataObject.php b/core/model/DataObject.php
@@ -1391,6 +1391,9 @@ public function getRemoteJoinField($component, $type = 'has_many') {
 
 	/**
 	 * Sets the component of a relationship.
+	 * This should only need to be called internally,
+	 * and is mainly due to the caching logic in {@link getComponents()}
+	 * and {@link getManyManyComponents()}.
 	 *
 	 * @param string $componentName Name of the component
 	 * @param DataObject|ComponentSet $componentValue Value of the component