README

Установка

$ composer require --dev kosuha606/minidoc

Quick Start

Инструмент для быстрого сбора документации из аннтоаций классов в проекте.

Пример вывода документации:

<?php
echo (new DocsBuilder())
    ->addParseParam('category')
    ->addParseParam('description')
    ->addParseParam('version')
    ->addClassRegexp('/classes/')
    ->addPreloadClassesDir(__DIR__.'/classes')
    ->buildTemplate()
;

Пример работы

Настройка

Добавить стили или скритпы в шаблон:

$docsBuilder->addStyle(new ResourceDTO(__DIR__.'/resources/style.css', ResourceDTO::TYPE_FILE));
$docsBuilder->addScript(new ResourceDTO(__DIR__.'/resources/script.js', ResourceDTO::TYPE_FILE));

Отрендерить свой шаблон документации:

$docsBuilder->setViewTemplate(__DIR__.'/views/main.php');

Добавтиь свои параметры для парсинга в аннотациях:

$docsBuilder->setParseParams(['category', 'description']);
$docsBuilder->addParseParam('mark');

Настроить предзагрузку классов путем передачи пути к директории с классами:

$docsBuilder->addPreloadClassesDir(__DIR__.'/../../../../contexts');

Обработать данные после их построения

$docBuilder->afterBuildData(function() {});

Установить регулярное выражение для выбора файлов из указанной директории

$docBuilder->setFilesRegexp();

Выбрать язык вывода или указать свой языковой файл

$docBuilder->setLanguage('ru');
// Или указать свой массив переводов
$docBuilder->setTranslations(require_once __DIR__.'/ch.php');

Change log

1.0.13 (2020-04-14)

Фикс ошибки сброса кэша

1.0.12 (2020-04-14)

Фикс метода setCacheFile

1.0.11 (2020-04-14)

Добавил парсинг анотаций методов

1.0.10 (2020-04-14)

Поправил привязку к внешним пакетам composer

1.0.9 (2020-04-11)

Добавлена интернационализация
Добавлено кэширование и возможность сброса кэша

kosuha606 / minidoc

Maintainers

Details