0x00-dev/phpdocgen

Easy static documentation generator

Installs: 17

Dependents: 0

Suggesters: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:package

v1.1.2 2018-10-30 14:29 UTC

README

PHP static documentation generator

Build Status

Как использовать:

  1. Скопировать файл phpdocgen.json в директорию генерации (рекомендуется корень приложения).
  2. Настроить параметры генерации.

Если проект был распакован/клонирован:

Запустить vendor/bin/phpdocgen из директории с конфигурацией.

Если проект установлен в качестве зависимости:

(new \PDG\Component\DocGenerator())
    ->setConfigFile('path_to_your_config/phpdocgen.json')
    ->run();

Настройка генератора

phpdocgen.json

{
  "src" : "src",
  "dst" : "docs",
  "exclude" : [".", "..", ".git", ".idea"],
  "file_pattern" : "^[a-zA-Z0-9\\_]+\\.php$",
  "removed_prefix" : "",
  "twig_options" : {
    "this_name" :  "PHP static documentation generator"
  }
}
Параметр Описание По умолчанию
src Директория с кодом для генерации документации src
dst Конечная директория документации docs
exclude Исключаемые директории [".", "..", ".git", ".idea"]
file_pattern Шаблон поиска имени файла для генерации ^[a-zA-Z0-9\_]+\.php$
removed_prefix Удаялемый префикс пути
twig_options Параметры для передачи в шаблонизатор
this_name Имя документации. Учавствует в title и brand PHP static documentation generator

Наличие всех параметров в конфигурации не обязательно.