0x00-dev/phpdocgen

Easy static documentation generator

v1.2.0 2022-08-29 08:47 UTC

Requires

• ext-json: *
• codeception/codeception: ^2.4

Requires (Dev)

• phpstan/phpstan: ^0.10.0@dev
• twig/twig: ^2.5

GPL-3.0-or-later

• 0x00-dev

README

PHP static documentation generator

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

1. Настроить параметры генерации.

Работа через терминал:

Запустить 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"
  },
  "flags" : ["-l"]
}

Параметр	Описание	По умолчанию
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
flags	Флаги	[-l]

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

Флаг	Описание
-l	Выводить список сгенерированных файлов.