Add doc-comments

jxlwqq · jxlwqq · commit 3ccebc25bfe4 · 2018-09-09T18:18:31.000+08:00
diff --git a/src/Helper.php b/src/Helper.php
@@ -26,7 +26,7 @@ private function _getPosWeight()
     /**
      * 获取数字补位.
      *
-     * @param $str
+     * @param string|int $str 字符串
      * @param int    $len   长度
      * @param string $chr   补位值
      * @param bool   $right 左右
@@ -285,7 +285,8 @@ private function _generatorCheckBit($body)
     /**
      * 生成地址码
      *
-     * @return string
+     * @param string $address 地址（行政区全称）
+     * @return false|int|string
      */
     private function _generatorAddressCode($address)
     {
@@ -331,6 +332,8 @@ private function _generatorAddressCode($address)
     /**
      * 生成出生日期码
      *
+     * @param int|string $birthday 出生日期
+     *
      * @return string
      */
     private function _generatorBirthdayCode($birthday)
@@ -366,7 +369,9 @@ private function _generatorBirthdayCode($birthday)
     /**
      * 生成顺序码
      *
-     * @return string
+     * @param int $sex 性别
+     *
+     * @return int|string
      */
     private function _generatorOrderCode($sex)
     {
diff --git a/src/IdValidator.php b/src/IdValidator.php
@@ -105,8 +105,8 @@ public function getInfo($id)
      *
      * @param bool                  $eighteen 是否为 18 位
      * @param null|string|array     $address  地址
-     * @param null|string|int       $sex      性别（1为男性，0位女性）
      * @param null|string|int|array $birthday 出生日期
+     * @param null|string|int       $sex      性别（1为男性，0位女性）
      *
      * @return string
      */

Original file line number	Diff line number	Diff line change
`@@ -105,8 +105,8 @@ public function getInfo($id)`
`105`	`105`	`*`
`106`	`106`	`* @param bool $eighteen 是否为 18 位`
`107`	`107`	`* @param null\|string\|array $address 地址`
`108`		`- * @param null\|string\|int $sex 性别（1为男性，0位女性）`
`109`	`108`	`* @param null\|string\|int\|array $birthday 出生日期`
	`109`	`+ * @param null\|string\|int $sex 性别（1为男性，0位女性）`
`110`	`110`	`*`
`111`	`111`	`* @return string`
`112`	`112`	`*/`