Я интегрирую PHP doc с моим продуктом, так как планирую позволить пользователям изменять различные вещи внутри плагина.
Пока все хорошо, у меня в каталоге есть phpdoc .phar, и я могу разобратьHTML-файлы.Но у меня есть две проблемы:
1 - я не могу понять, как именно использовать тег @example,
Вот мой код:
/**
* Creates a custom cron schedule.
* @param array $schedules list of schedules
* @example class-wcdpue-admin.php add_filter( 'wcdpue_custom_cron_schedule', 300 ); Creates a custom cron
* @since 2.0.0
*/
public function wcdpue_custom_cron_schedule( $schedules ){
$schedules['wcdpue_cron'] = array(
'interval' => apply_filters( 'wcdpue_custom_cron_schedule', 900 ),
'display' => __( 'Every 15 Minutes' )
);
return $schedules;
}
Когда япроверьте phpdoc, он выглядит так:
Я не уверен, почему он говорит, что файл не найден, но я не могу найти пример в Интернетедля использования этого тега я ожидал, что он покажет небольшое поле кода с моим примером использования.
2 - Как я могу исправить проблему с не найденным файлом?
Путь к файлу классаoop/admin/class-wcdpue-admin.php и я попытался изменить блок doc на:
/**
* Creates a custom cron schedule.
* @param array $schedules list of schedules
* @example /admin/class-wcdpue-admin.php add_filter( 'wcdpue_custom_cron_schedule', 300 ); Creates a custom cron
* @since 2.0.0
*/
public function wcdpue_custom_cron_schedule( $schedules ){
$schedules['wcdpue_cron'] = array(
'interval' => apply_filters( 'wcdpue_custom_cron_schedule', 900 ),
'display' => __( 'Every 15 Minutes' )
);
return $schedules;
}
Команда phpdoc, которую я выполняю: php phpDocumentor.phar -d oop/ -t docs/api --sourcecode, если она мне нужна, я также не вижу исходный код из обработанного phpdocдля любого из моих определенных блоков по какой-то причине:
Любая помощь приветствуется