From 373bed0de4b54327e19b423676ae377dc76ef6bb Mon Sep 17 00:00:00 2001
From: Zhao vistart <i@vistart.vip>
Date: Wed, 7 Jun 2017 20:15:50 +0800
Subject: [PATCH] improve notes. [skip ci]

---
 traits/SubsidiaryTrait.php | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/traits/SubsidiaryTrait.php b/traits/SubsidiaryTrait.php
index 675ab73..ad6c77b 100644
--- a/traits/SubsidiaryTrait.php
+++ b/traits/SubsidiaryTrait.php
@@ -15,6 +15,15 @@
 use yii\base\InvalidConfigException;
 
 /**
+ * SubsidiaryTrait.
+ * The Trait is used to help the model manage its subsidiary models.
+ *
+ * For example:
+ * ```php
+ * $user->addSubsidiaryClass("email", ["class" => Email::class]);
+ * $email = $user->createEmail(['content' => 'i@vistart.me']);
+ * $email->save();
+ * ```
  * @version 1.0
  * @author vistart <i@vistart.me>
  */
@@ -72,7 +81,7 @@ public function addSubsidiaryClass($name, $config)
 
     /**
      * Remove subsidiary.
-     * @param string $name
+     * @param string $name Subsidiary name, case insensitive.
      * @return boolean
      */
     public function removeSubsidiary($name)
@@ -86,8 +95,8 @@ public function removeSubsidiary($name)
     }
 
     /**
-     * Get subsidiary class.
-     * @param string $name
+     * Get subsidiary class according name.
+     * @param string $name Subsidiary name, case insensitive.
      * @return string
      */
     public function getSubsidiaryClass($name)
@@ -101,7 +110,7 @@ public function getSubsidiaryClass($name)
 
     /**
      * Get subsidiaries.
-     * @param $name
+     * @param $name Subsidiary name, case insensitive.
      * @param string $limit
      * @param int $page
      * @return null
@@ -199,9 +208,9 @@ public function create($className, $config = [], $loadDefault = true, $skipIfSet
     }
 
     /**
-     *
-     * @param string $name
-     * @param array $config
+     * Create subsidiary model.
+     * @param string $name Subsidiary name, case insensitive.
+     * @param array $config Subsidiary model configuration array.
      * @return mixed
      */
     public function createSubsidiary($name, $config)