* rewrite the comments of productplan module.

module/productplan/control.php

@@ -11,7 +11,13 @@
  */
 class productplan extends control
 {
-    /* 公共操作。*/
+    /**
+     * Common actions
+     * 
+     * @param  int    $productID 
+     * @access public
+     * @return void
+     */
     public function commonAction($productID)
     {
         $this->loadModel('product');
@@ -20,7 +26,13 @@ class productplan extends control
         $this->product->setMenu($this->product->getPairs(), $productID);
     }
 
-    /* 添加产品计划。*/
+    /**
+     * Create a plan.
+     * 
+     * @param  int    $product 
+     * @access public
+     * @return void
+     */
     public function create($product = '')
     {
         if(!empty($_POST))
@@ -37,7 +49,13 @@ class productplan extends control
         $this->display();
     }
 
-    /* 编辑产品计划。*/
+    /**
+     * Edit a plan.
+     * 
+     * @param  int    $planID 
+     * @access public
+     * @return void
+     */
     public function edit($planID)
     {
         if(!empty($_POST))
@@ -60,7 +78,14 @@ class productplan extends control
         $this->display();
     }
                                                           
-    /* 删除计划。*/
+    /**
+     * Delete a plan.
+     * 
+     * @param  int    $planID 
+     * @param  string $confirm  yes|no
+     * @access public
+     * @return void
+     */
     public function delete($planID, $confirm = 'no')
     {
         if($confirm == 'no')
@@ -75,7 +100,13 @@ class productplan extends control
         }
     }
 
-    /* 浏览计划列表。*/
+    /**
+     * Browse plans.
+     * 
+     * @param  int    $product 
+     * @access public
+     * @return void
+     */
     public function browse($product = 0)
     {
         $this->session->set('productPlanList', $this->app->getURI(true));
@@ -86,13 +117,22 @@ class productplan extends control
         $this->display();
     }
 
-    /* 计划详情。*/
+    /**
+     * View plan.
+     * 
+     * @param  int    $planID 
+     * @access public
+     * @return void
+     */
     public function view($planID = 0)
     {
         $this->session->set('storyList', $this->app->getURI(true));
+
         $plan = $this->productplan->getByID($planID);
         if(!$plan) die(js::error($this->lang->notFound) . js::locate('back'));
+
         $this->commonAction($plan->product);
+
         $this->view->header->title = $this->lang->productplan->view;
         $this->view->position[] = $this->lang->productplan->view;
         $this->view->planStories= $this->loadModel('story')->getPlanStories($planID);
@@ -103,7 +143,13 @@ class productplan extends control
         $this->display();
     }
 
-    /* 关联需求。*/
+    /**
+     * Link stories.
+     * 
+     * @param  int    $planID 
+     * @access public
+     * @return void
+     */
     public function linkStory($planID = 0)
     {
         $this->session->set('storyList', $this->app->getURI(true));
@@ -123,7 +169,14 @@ class productplan extends control
         $this->display();
     }
 
-    /* 移除一个需求。*/
+    /**
+     * Unlink story 
+     * 
+     * @param  int    $storyID 
+     * @param  string $confirm  yes|no
+     * @access public
+     * @return void
+     */
     public function unlinkStory($storyID, $confirm = 'no')
     {
         if($confirm == 'no')

module/productplan/model.php

@@ -13,13 +13,25 @@
 <?php
 class productplanModel extends model
 {
-    /* 获取计划信息。*/
+    /**
+     * Get plan by id.
+     * 
+     * @param  int    $planID 
+     * @access public
+     * @return object
+     */
     public function getByID($planID)
     {
         return $this->dao->findByID((int)$planID)->from(TABLE_PRODUCTPLAN)->fetch();
     }
 
-    /* 获取列表。*/
+    /**
+     * Get list 
+     * 
+     * @param  int    $product 
+     * @access public
+     * @return object
+     */
     public function getList($product = 0)
     {
         return $this->dao->select('*')->from(TABLE_PRODUCTPLAN)->where('product')->eq($product)
@@ -27,7 +39,14 @@ class productplanModel extends model
             ->orderBy('begin')->fetchAll();
     }
 
-    /* 获取name=>value的键值对。*/
+    /**
+     * Get plan pairs.
+     * 
+     * @param  int    $product 
+     * @param  string $expired 
+     * @access public
+     * @return array
+     */
     public function getPairs($product = 0, $expired = '')
     {
         $date = date('Y-m-d');
@@ -40,7 +59,13 @@ class productplanModel extends model
             ->orderBy('begin')->fetchPairs();
     }
 
-    /* 创建。*/
+    /**
+     * Create a plan.
+     * 
+     * @param  int    $product 
+     * @access public
+     * @return int
+     */
     public function create($product)
     {
         $plan = fixer::input('post')
@@ -51,7 +76,13 @@ class productplanModel extends model
         if(!dao::isError()) return $this->dao->lastInsertID();
     }
 
-    /* 编辑。*/
+    /**
+     * Update a plan
+     * 
+     * @param  int    $planID 
+     * @access public
+     * @return array
+     */
     public function update($planID)
     {
         $oldPlan = $this->getById($planID);
@@ -64,7 +95,13 @@ class productplanModel extends model
 
     }
 
-    /* 关联需求。*/
+    /**
+     * Link stories.
+     * 
+     * @param  int    $planID 
+     * @access public
+     * @return void
+     */
     public function linkStory($planID)
     {
         $this->loadModel('story');
@@ -77,7 +114,13 @@ class productplanModel extends model
         }        
     }
 
-    /* 移除需求。*/
+    /**
+     * Unlink story 
+     * 
+     * @param  int    $storyID 
+     * @access public
+     * @return void
+     */
     public function unlinkStory($storyID)
     {
         $planID = $this->dao->findByID($storyID)->from(TABLE_STORY)->fields('plan')->fetch('plan');