phpdoc - 作り方 work in ApiGen

Answer 1

ApiGen では、プレーンな説明を最初に配置し、その後にすべてのタグ行を配置する必要があります。

関数の使用方法の例は、次のように@exampleタグに入れる必要があります。

/**
 * Short desc
 *
 * @param  array   $tabs
 * @return boolean       true if all tabs created / false if have some error
 * @example
 * <code>
 * $admin_tabs = array(
 *           'AdminDeliveryManager' => array('name' => 'Delivery manager', 'id_parent' => 0),
 *           'AdminRole' => array('name' => 'Admin role', 'id_parent' => -1),
 *           'AdminEmployeeRole' => array('name' => 'Admin role', 'id_parent' => -1)
 *       );
 * createTabs($admin_tabs);
 * </code>
 */