2021-08-20: Версия 3.1.1
Исправлено
- Добавлен обходной путь для распространения phar и plantuml, благодаря [Jaapio].
- В XML шаблоне был обнаружен недопустимый XML из-за отсутствия маркера .type, #2986, благодаря [Jaapio].
- Признаки класса не отображаются в документации, #2984, благодаря [Jaapio].
- Файлы с принудительным глобальным пространством имён не работают с ошибкой «не является допустимым Fqsen», #2967, благодаря [Jaapio].
- В выводе XML отсутствуют теги методов, #2965, благодаря [Jaapio].
CI
- Обновлены проверки стиля кода, благодаря [jrfnl].
2021-07-07: Версия 3.1.0
ДОБАВЛЕНО
- Исправлено использование параметров в шаблонах, благодаря [Jaapio].
- Представлен вид исходного кода в стандартном шаблоне #2919, благодаря [Jaapio].
- Отображение описания переменных для свойств и констант, благодаря [Jaapio].
- Расширение дескриптора руководства с конфигурацией, благодаря [Jaapio].
- Добавление экрана справки к нашей настройке Make, благодаря [Mike van Riel].
- Добавление исходного значения объекта в конфигурацию #2855, благодаря [Jaapio].
- Руководства: написание теста для RenderCommand, благодаря [Mike van Riel].
- Руководства: добавление дополнительных тестов, благодаря [Mike van Riel].
- Руководства: завершение/введение директивы versionadded, благодаря [Mike van Riel].
- Руководства: удаление slug из Environment, дополнительная очистка, благодаря [Mike van Riel].
- Руководства: автоматическое определение директив для форматов, благодаря [Mike van Riel].
- Поддержка синтаксиса PHP 8, благодаря [Jaapio].
- Руководства: сделать параметры первоклассными гражданами, перейти к автозагрузке, благодаря [Mike van Riel].
- Руководства: удалить старые классы и назвать их более согласованно с остальными, благодаря [Mike van Riel].
- Руководства: Удалить createSpanNode из Parser, благодаря [Mike van Riel].
- Руководства: Рефакторинг NodeFactory и Instantiators, благодаря [Mike van Riel].
- Руководства: дополнительная очистка, благодаря [Mike van Riel].
- Руководства: рефакторинг последних сервисных ссылок из узлов, благодаря [Mike van Riel].
- Перенос рендеринга директив Guide на расширение Twig, благодаря [Mike van Riel].
- Руководства: Удаление функций рендеринга из twig, благодаря [Mike van Riel].
- Руководства: Удалены неиспользуемые части шаблона, благодаря [Mike van Riel].
- Перемещение инициализации twig на этап инициализации #2845, благодаря [Jaapio].
- Упрощение рендереров узлов и путей рендеринга, благодаря [Mike van Riel].
- Руководства: Завершение Flyweighting NodeRenderers, благодаря [Mike van Riel].
- Руководства: Необходимость обновления DocumentNodeRenderer и Default renderer, благодаря [Mike van Riel].
- Руководства: Рефакторинг рендереров в Flyweights, благодаря [Mike van Riel].
- Обновление PlantUmlClassDiagram для использования нового рендерера, благодаря [Mike van Riel].
- Разделение трансформатора от создания шаблона, благодаря [Jaapio].
- Стилизация диаграммы активности и разрешение классов, благодаря [Mike van Riel].
- Рендеринг диаграмм UML с использованием plantuml #2840, благодаря [Mike van Riel].
- Руководства: Копирование актива при использовании директивы Image, благодаря [Mike van Riel].
- Руководства: Рендеринг блоков кода, благодаря [Mike van Riel].
- Разделить этапы компиляции и преобразования, благодаря [Jaapio].
- Повышение phpunit для php8, благодаря [Jaapio].
- Введение VersionSpecification, благодаря [orklah].
- Улучшение документации и добавление парсера Markdown, благодаря [Mike van Riel].
- Улучшение TOC для руководств, благодаря [Mike van Riel].
- Попытка загрузить правильную версию phpunit в phive на основе версии php, благодаря [orklah].
- Попытка изменить диапазон версий phive для поддержки php8, благодаря [orklah].
- Попытка запуска на php 8, благодаря [orklah].
- Повторное введение обнаружения неиспользуемого кода, благодаря [orklah].
- Добавить тест для значения параметра по умолчанию, благодаря [Jaapio].
- Использовать оператор объединения null, когда это более логично, благодаря [orklah].
ИСПРАВЛЕНО
- Поддержка UTF-8 в содержимом таблиц reST #2938, благодаря [David Stächele].
- Добавьте описание необходимых тегов фильтров, благодаря [Jaapio].
- Исправить отображение постоянной величины как пустой строки при нулевом значении #2894, благодаря [WhizSid].
- Исправление проблем с разрешениями из-за flysystem, благодаря [Jaapio].
- Fix #2832: Определение местоположения plantuml с помощью каталога проекта, благодаря [Mike van Riel].
- Fix #2833 Содержимое предупреждения не отображается, благодаря [Mike van Riel].
- Добавить symfony/polyfill-intl-idn для исправления проблемы с php 7.4, благодаря [Jaapio].
- Исправить стиль интерфейса расширяет, благодаря [Jaapio].
- Удалить зависимость proxymanager, благодаря [Jaapio]. Исходный текст:
href in search, thanks to [Jaapio]
- Fix bug in dsn resolving, thanks to [Jaapio]
- Typo fix, thanks to [Jaapio]
- Fix set source, thanks to [Jaapio]
- Fix example notice, thanks to [Jaapio]
- Fix visibility calculation, thanks to [Jaapio]
- Fix notice in tests, thanks to [Jaapio]
- Reimplement filters to use ApiSpecification, thanks to [Jaapio]
- Add validate flag to config, thanks to [Jaapio]
- Wip for api config object, thanks to [Jaapio]
- Leverage newer API of PrettyVersion, thanks to [Alessandro Lai]
- default version should be '1.0.0', not numeric, thanks to [orklah]
- fix #2686 Font Awesome is loaded twice in the HTML template, with conflicting technologies, thanks to [Mike Wilkerson]
- Show Summary and Description for files, thanks to [Mike van Riel]
- Define statements were not parsed as the strategy was not present, thanks to [Mike van Riel]
- Fix #2466 Followup: XML template - description of property empty, thanks to [Jeff Horton]
- Name test sensibly, thanks to [Jeff Horton]
- Fix #2466 - replace twig variables with the updated names - add a functional test for the xml out put containing the expected outputs, thanks to [Jeff Horton]
Перевод:
- href в поиске, спасибо [Jaapio].
- Исправление ошибки в разрешении dsn, спасибо [Jaapio].
- Исправлена опечатка, спасибо [Jaapio].
- Исправлено задание источника, спасибо [Jaapio].
- Исправлено уведомление примера, спасибо [Jaapio].
- Исчислено вычисление видимости, спасибо [Jaapio].
- Исправлено уведомление в тестах, спасибо [Jaapio].
- Фильтры повторно реализованы для использования ApiSpecification, спасибо [Jaapio].
- Добавлен флаг проверки в конфигурацию, спасибо [Jaapio].
- WIP для объекта конфигурации API, спасибо [Jaapio].
- Использован более новый API PrettyVersion, спасибо [Alessandro Lai].
- Версия по умолчанию должна быть «1.0.0», а не числовой, спасибо [orklah].
- исправлена ошибка № 2686: Font Awesome загружается дважды в шаблоне HTML с конфликтующими технологиями, спасибо [Майку Уилкерсону].
- Отображение сводки и описания файлов, спасибо [Майку ван Рилу].
- Определения не были проанализированы, так как стратегия отсутствовала, спасибо [Майку ван Рилу].
- Ошибка № 2466: последующая обработка — шаблон XML — описание свойства пустое, спасибо [Джеффу Хортону].
- Тест назван разумно, спасибо [Джефф Хортон].
- Ошибка № 2466 — замена переменных веточки на обновлённые имена — добавление функционального теста для вывода XML, содержащего ожидаемые результаты, спасибо [Джеффу Хортону].*
В запросе нет информации о том, к какой области относится текст или на каком языке написан исходный текст. В результате перевода могут быть неточности. Благодаря [Jaapio]:
2020-10-23: Версия 3.0.0
ДОБАВЛЕНО
- Разрешить настройку CSS, благодаря [Jaapio].
- Фильтровать неразрешённые интерфейсы, благодаря [Jaapio].
- Добавить отсутствующую функцию в шаблон XML, благодаря [Jaapio].
- Исправить проблемы в structure.xml, благодаря [Jaapio].
- Восстановить файл структуры XML, благодаря [Jaapio].
- Включить видимость для ConstantDescriptor и constantAssembler, благодаря [Orklah].
- Улучшить тест для класса Template, благодаря [Mike van Riel].
- Создать индекс файлов и сделать его более расширяемым, благодаря [Mike van Riel].
- Отображать типы коллекций в виде ссылок, благодаря [Jaapio].
- Добавить рамку к боковой панели шаблона по умолчанию, благодаря [Jaapio].
- Отключить кэширование шаблонов Twig и всегда включать отладку, благодаря [Mike van Riel].
- Изменить дизайн заголовка, благодаря [Mike van Riel].
- Доработать стиль шаблона по умолчанию и включить заголовок в конфигурационный XSD, благодаря [Mike van Riel].
- Перепроектировать боковую панель / навигацию для шаблона по умолчанию, благодаря [Mike van Riel].
- Добавить значки private и protected в оглавление, благодаря [Mike van Riel].
- Обновить обновления для оглавления, благодаря [Mike van Riel].
- Разделить шаблоны на более мелкие шаблоны, благодаря [Mike van Riel].
- Вынести записи TOC в отдельный шаблон, благодаря [Mike van Riel].
- Подписать стилизовать подпись в соответствии с кодом, благодаря [Mike van Riel].
- Вернуть $ и () в записи TOC, благодаря [Mike van Riel].
- Удалить prettify из JavaScripts, благодаря [Mike van Riel].
- Разбить методы и свойства на подшаблоны для повторного использования, благодаря [Mike van Riel].
- Реструктурировать CSS, благодаря [Mike van Riel].
- Очистить пространства имён, пакеты и файлы шаблонов индексов, благодаря [Mike van Riel].
- Заменить содержимое шаблонов пространств имён и файлов компонентами, благодаря [Mike van Riel].
- Вернуться наверх + различные изменения, благодаря [Mike van Riel].
- Кэшировать ресурсы в демонстрационном приложении, благодаря [Mike van Riel].
- Обновить снимок экрана для демонстрации, благодаря [Mike van Riel].
- Интегрировать RST-Parser в phpDocumentor для ускорения итераций, благодаря [Mike van Riel].
И так далее... # Удалено
- Удалить избыточные функции и добавить тесты, благодаря [Майку ван Рилу].
- Удалить избыточные сеттеры и завершить тест, благодаря [Майку ван Рилу].
- Удалить предложение установить расширение Twig PHP, благодаря [Майку ван Рилу].
- Удалить Behat из сборки, благодаря [Майку ван Рилу].
Исправлено
-
Шаблон по умолчанию: нормализовать заголовки разделов, благодаря [jrfnl].
-
Исправить включение тегов в функцию, благодаря [Jaapio].
-
Переместить поисковый ввод наверх, благодаря [Майку ван Рилу].
-
Реструктурировать TOC для использования DL вместо таблицы, благодаря [Майку ван Рилу].
-
Перемещены CSS и подправлен дизайн topnav, благодаря [Майку ван Рилу].
-
Перенести TOC, Breadcrumbs и теги в компоненты, благодаря [Майку ван Рилу].
-
Очистить список расширений (origin/php-extensions, php-extensions), благодаря [Jaapio].
-
Экранировать HTML в Markdown, благодаря [Jaapio].
-
Улучшить рендеринг тегов docblock, благодаря [Jaapio].
-
ConstantDescriptor не может иметь FileDescriptor в качестве родителя, благодаря [Orklah].
-
Исправить использование числовой версии, благодаря [Jaapio].
-
Исправить версию и теги since в шаблоне по умолчанию, благодаря [Jaapio].
-
Сделать так, чтобы getTypes никогда не возвращал нулевые значения, благодаря [Orklah].
-
Обеспечить расширение Wildcards phpDocumentor2, благодаря [Майку ван Рилу].
-
Устранить проблему с недопустимыми именованными магическими свойствами, благодаря [Jaapio].
-
Использовать заголовок и шаблон из конфигурации v2, благодаря [Jaapio].
-
Дескриптор свойств представлен в формате Markdown, благодаря [Jaapio].
-
Internal является дополнением к другим видимостям, благодаря [Jaapio].
-
Удалить ext-ctype из предложения, потому что он уже требуется, благодаря [Рэнди Гераадсу].
-
XSD: обновить URL phpdoc.org на https, благодаря [jrfnl].
-
Исправляет #2442: показать «mixed» в TOC для свойств без типа, благодаря [Майку ван Рилу].
-
Значения констант в TOC должны быть однострочными, благодаря [Майку ван Рилу].
-
Константы не должны показывать знак доллара в подписи, благодаря [Майку ван Рилу].
-
Правильно отображать ссылки на FQSEN-ссылки, благодаря [Майку ван Рилу].
-
Значение свойства по умолчанию 0 отображается как пустая строка, благодаря [Майку ван Рилу].
-
Предотвратить дублирование методов, свойств и констант, благодаря [Майку ван Рилу].
-
Добавить глубокие ссылки и настроить сетку, благодаря [Майку ван Рилу].
-
Упростить классы сетки и соответствовать стандартам, благодаря [Майку ван Рилу].
-
Исправляет № 2457: не показывать глобальное пространство имён, когда оно пустое, благодаря [Майку ван Рилу].
-
Различные изменения в шаблоне по умолчанию, благодаря [Майку ван Рилу].
-
Удалить косые черты из значений по умолчанию, благодаря [Jaapio].
-
Вернуть добавленные косые черты к значению константы, благодаря [Jaapio].
-
Исправить путь графа, благодаря [Jaapio].
-
Исправить проблемы после анализа vendor dir, благодаря [Jaapio].
-
исправить синтаксическую ошибку в базовом шаблоне, благодаря [Jaapio].
-
улучшить рендеринг ссылок для типов списков, благодаря [Jaapio].
-
Исправить отображение возвращаемого типа и описания параметров, благодаря [Jaapio].
-
предотвратить ошибку PHP. Причина: параметр типа для магического свойства может быть нулевым, благодаря [Акселю Криштофяку].
-
исправлена ошибка phpstan, благодаря [Рэнди Гераадсу].
-
Частично исправить удаление встроенных тегов, благодаря [Jaapio].
-
Добавить тестовый пример для задачи №2425, благодаря [Jaapio].
-
Разрешить нулевые описания, благодаря [Jaapio].
-
Обновить CSS отсутствующими частями с веб-сайта и обновить документы, благодаря [Майку ван Рилю].
-
Обновите стиль демонстрационного сайта, благодаря [Майку ван Рилю].
-
Исправить рендеринг ссылки, благодаря [Jaapio].
-
Исправить определение констант пространства имён (origin/fix-namespace-constants), благодаря [Jaapio].
-
Применять короткую нотацию элементов по умолчанию, благодаря [Jaapio].
-
устраняет дублированные журналы, благодаря [Jaapio].
-
Убедитесь, что трейты являются частью пространства имён, благодаря [Jaapio].
-
Добавьте конструктор в редукторы, благодаря [Jaapio].
-
Исправление проверки инъекции редуктора, благодаря [Jaapio].
-
Повторно ввести примеры в конфигурацию и cli, благодаря [Jaapio].
-
ослабить порядок xsd, благодаря [Jaapio].
-
[GUIDES] Изменить ссылку на URL, чтобы меню работало лучше, благодаря [Майку ван Рилю].
-
Убедитесь, что руководства отображаются в нужном месте, благодаря [Майку ван Рилю].
-
Расширить список имён файлов конфигурации по умолчанию, благодаря [Jaapio].
-
Разрешить несколько видимостей, благодаря [Jaapio].
-
Удалить обязательные настройки пути, благодаря [Jaapio]. Фильтр констант, благодаря [Jaapio].
-
Добавить тесты для видимости, благодаря [Jaapio].
-
Исправить аргумент командной строки ignore-tags, благодаря [Jaapio].
-
Обновить наш собственный конфиг, чтобы игнорировать теги, благодаря [Jaapio].
-
Добавить фильтр strip tags, благодаря [Jaapio].
-
Исправить загрузку конфигурации для ignore-tags, благодаря [Jaapio].
-
Улучшить создание фильтров элементов, благодаря [Jaapio].
-
Включить blockquote и исправить высоту в навигационной панели, благодаря [Mike van Riel].
-
Поиск ссылок на главной странице не работает, благодаря [Mike van Riel].
-
Шаблон по умолчанию не обладает адаптивностью, благодаря [Mike van Riel].
-
Настроить навигацию, благодаря [Mike van Riel].
-
Убрать диспетчеризацию событий из Node и написать тест, благодаря [Mike van Riel].
-
Добавить значение по умолчанию для null значений, благодаря [Jaapio].
-
Решить проблемы со стилем (origin/bugfix/2493), благодаря [Mike van Riel].
-
Решить последние проблемы в шаблоне по умолчанию, благодаря [Mike van Riel].
Безопасность
- Обновите Cypress, чтобы решить проблемы с безопасностью, благодаря [Mike van Riel].
- Обновлён http-foundation для решения обнаруженных проблем с безопасностью, благодаря [Mike van Riel].
DOCS
- Улучшен макет комментария после «ваша среда», благодаря [HonkingGoose].
- Улучшен шаблон отчёта об ошибке, благодаря [HonkingGoose]].
- Добавлены пробелы для читаемости, благодаря [HonkingGoose].
- Используется правильное написание слова GitHub, благодаря [HonkingGoose].
- Обновлено README.md, благодаря [HonkingGoose].
- Очищены документы, благодаря [Jaapio].
- Добавлена документация по файловой системе, благодаря [Jaapio].
- Исправлено ещё больше ссылок в документах, благодаря [Mike van Riel].
- Исправлены ссылки в документации, благодаря [Mike van Riel].
- Исправлены опечатки в документах, благодаря [Mike van Riel].
- Улучшена документация FileDescriptor, благодаря [Jaapio].
- Добавлены теги для улучшения документации API для шаблонов, благодаря [Jaapio].
- Добавлено указание на сводные тексты в виде простого текста, благодаря [Jaapio].
- Небольшие улучшения в документации, благодаря [Jaapio].
- Удалены все страницы «в разработке», благодаря [Mike van Riel].
- Документы: улучшения для «приступаем к работе — изменение внешнего вида», благодаря [jrfnl].
- Документы: дальнейшие улучшения для «установка», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — внутренние», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — версия», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — var», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — todo», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — throws», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — подпакет», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — см.», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — filesource», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — устаревшие», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — авторские права», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — категория», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — пакет», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — ссылка», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — лицензия», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — игнорировать», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — автор», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — api», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — свойство[<-чтение|-запись>]», благодаря [jrfnl].
- Документы: улучшения для «приступаем к работе — ваш первый набор документации», благодаря [jrfnl].
- Документы: улучшения для «ссылки — phpdoc — теги — метод», благодаря [jrfnl].
- Документы: улучшения для «установки», благодаря [jrfnl].
- Документы: исправлены различные ссылки [общедоступные], благодаря [jrfnl].
- Исправлены ссылки на веб-сайт phpdoc.org [фикстуры для тестов], благодаря [jrfnl].
- Исправлены ссылки на веб-сайт phpdoc.org [блоки документов для тестов], благодаря [jrfnl].
- Исправлены ссылки на... Текст запроса:
phpdoc.org website [src file docblocks], thanks to [jrfnl]
- Fix references to the phpdoc.org website [templates], thanks to [jrfnl].
- Fix references to the phpdoc.org website [docs website], thanks to [jrfnl].
- Fix references to the phpdoc.org website [public facing], thanks to [jrfnl].
- Docs: remove
:term:
annotations, thanks to [jrfnl].
И так далее.
Перевод:
Сайт phpdoc.org [блоки документов в файлах src], благодаря [jrfnl].
— Исправьте ссылки на сайт phpdoc.org [шаблоны], благодаря [jrfnl].
— Исправьте ссылки на веб-сайт phpdoc.org [веб-сайт документации], благодаря [jrfnl].
— Исправьте ссылки на общедоступный сайт phpdoc.org, благодаря [jrfnl].
— Документы: удалите аннотации :term:
, благодаря [jrfnl]. phpdoc, благодаря [orklah]:
— избыточное значение параметра по умолчанию;
— избыточная инициализация свойства;
— неиспользуемые переменные;
— использовать библиотеку Assert вместо нативного assert;
— создать MiddlewareInterface и нормализовать Middlewares;
— поднять Psalm до уровня 6;
— Phpstan не поддерживает наследование шаблонов + исправление различных проблем;
— изменение шаблонов для согласованности;
— заменить static на self и заменить className на self, где это применимо;
— пересобрать документацию при изменении шаблона, благодаря Майку ван Рилу.
2020-02-09: Версия 3.0.0-rc
Удалено:
— команда самообновления, благодаря Джаапио.
Исправлено:
— ошибки докблока теперь видны в шаблоне по умолчанию, #2250, благодаря Джаапио;
— run не игнорирует кэш с помощью --force
, #2257, благодаря Майку ван Рилу;
— --config=none
не учитывает аргументы командной строки, благодаря Джаапио;
— теги с телами, начинающимися с [
, не принимаются, #2260, благодаря Джаапио;
— файлы, начинающиеся с shebang, не анализируются, #2259, благодаря Джаапио;
— встроенные маркеры не обнаруживаются, #2256, благодаря Джаапио;
— файлы с кодировкой, отличной от utf-8, обрабатываются неправильно, #2254, благодаря Джаапио.
CI:
— довести PHPStan до уровня 6, благодаря Орклаху;
— внутренности лучше типизированы, благодаря Орклаху;
— обновить стандарты кодирования до стандартов phpdoc, благодаря Джаапио.
2020-01-31: Версия 3.0.0-beta
Критические изменения:
— минимальная версия PHP для запуска — 7.2, благодаря Майку ван Рилу;
— разработка на основе транка, благодаря Майку ван Рилу;
— поддержка шаблонов на основе XML была прекращена, благодаря Майку ван Рилу;
— поддержка рендеринга AST на основе структуры XML (structure.xml) была прекращена, благодаря Майку ван Рилу.
Добавлено:
— добавлен новый шаблон по умолчанию, благодаря Майку ван Рилу;
— добавлены отчёты в новый шаблон, благодаря Майку ван Рилу;
— добавлены недостающие видимости, благодаря Майку ван Рилу;
— добавлены шаблоны пространства имён и класса для новой темы по умолчанию, благодаря Майку ван Рилу;
— добавлен Dockerfile для документации, благодаря Джаапио;
— добавлена поддержка поиска и множество мелких функций в новом шаблоне, благодаря Майку ван Рилу;
— добавлена поддержка «deprecated» и тестирование различных модификаторов методов, благодаря Майку ван Рилу;
— добавлена поддержка типизированных свойств, благодаря Майку ван Рилу;
— добавлена поддержка конфигурации версии 2 и механизм обновления, благодаря Майку ван Рилу;
— добавлена версия в документацию сборки, благодаря Майку ван Рилу;
— разрешено использование «локальных» шаблонов, благодаря Майку ван Рилу;
— очищены версии зависимостей в Composer, благодаря Майку ван Рилу;
— папка кэша является нейтральной относительно операционной системы, благодаря Майку ван Рилу;
— переработан ввод-вывод файлов для писателей и преобразований, благодаря Майку ван Рилу;
— пользовательские настройки могут быть установлены из командной строки или конфигурации, благодаря Майку ван Рилу;
— проработана новая страница сведений о классе, благодаря Майку ван Рилу;
— улучшено управление константами в новом шаблоне, благодаря Майку ван Рилу;
— улучшен новый шаблон по умолчанию, благодаря Майку ван Рилу;
— улучшена визуализация свойств в новом шаблоне, благодаря Майку ван Рилу;
— начальная настройка для нового шаблона, благодаря Майку ван Рилу;
— внедрена FlySystem в загрузку файлов Twig, благодаря Майку ван Рилу;
— введена Symfony Config для анализа конфигурации, благодаря Майку ван Рилу;
— писатели должны иметь возможность предоставлять пользовательские настройки, благодаря Майку ван Рилу;
— рекурсивное обновление конфигурации до более новых версий, благодаря Майку ван Рилу;
— рендеринг файлов как часть нового шаблона и ссылка на них, благодаря Майку ван Рилу.
Исправлено:
— построение дерева '@package' не работало с некоторыми символами, благодаря Майку ван Рилу;
— очистка документации команды run, благодаря Джаапио;
— очистка заголовка файла для новой конфигурации, благодаря Майку ван Рилу;
— коллекции всегда заменялись, даже если они не были изменены, благодаря Майку ван Рилу;
— преобразование конфигурации v2 в v3 и приведение v3 к предыдущему виду, благодаря Майку ван Рилу;
— разрешить значения через запятую для -f
, благодаря Майку ван Рилу;
— разрешить default symfony. Выполнение команд благодаря [Jaapio]:
- определение нескольких API;
- настройка выходных папок (Mike van Riel);
- использование нескольких каталогов через запятую (Mike van Riel).
Исправление имён классов строк в тестах (50bhan):
- конфигурация нуждалась в корневом элементе «phpdocumentor» (Mike van Riel);
- преобразование слэшей вызывает проблемы вместо их исправления (Mike van Riel);
- конвертация URI в League URI (Mike van Riel);
- в Dockerfile не хватало && (Mike van Riel);
- проверка правильности имени файла и каталога (Mike van Riel);
- обеспечение существования папки config/secrets/prod (Mike van Riel);
- корректное отображение ссылок на типы, допускающие значение NULL (Mike van Riel).
Hotfix/docker-build #1976 (Jaap van Otterdijk):
- более надёжное обнаружение каталога vendor #2153 (jclaveau);
- замена Cocur/Slugify на Symfony/String #2165 (Mike van Riel);
- разрешение относительного пути #2193 (Jaap van Otterdijk);
- решение целевого пути #2196 (Jaap van Otterdijk);
- проблема с путём в Windows #2197 (Jaap van Otterdijk);
- разрешение пути шаблона в Windows #2202 (Jaap van Otterdijk).
Недействительная обработка тегов #2209, #2205 (Jaap van Otterdijk):
- завершение определения конфигурации для версии v2 (Mike van Riel);
- запись с помощью FlySystem (Mike van Riel);
- обновление до Symfony 5 (Mike van Riel);
- улучшение сообщения об ошибке при получении магических свойств (Jaapio);
- улучшение сообщения об ошибке для неверного пути (Jaapio).
Другие изменения:
- создание дополнительных исключений для конкретных доменов (Jaapio);
- фрагменты не могут быть выражены в маршруте (Mike van Riel);
- Monolog начал жаловаться на настройку в последней версии (Mike van Riel);
- передача "--config none" приводит к ошибке (Mike van Riel);
- phpDocumentor входит в бесконечный цикл, когда класс расширяет себя (Mike van Riel);
- нормализация имён пакетов (Mike van Riel);
- ссылки не отображаются в нужном месте (Mike van Riel);
- показ кавычек со строковыми значениями (Mike van Riel);
- неразрешённые типы не могли быть отображены (Mike van Riel).
Удалённые изменения:
- удаление проверки DocBlocks;
- удаление сжатия на phar (Jaapio);
- установка языка по умолчанию для каждого задания (Mike van Riel);
- удалены Travis и Appveyor, так как Github Actions выполняет всё необходимое (Mike van Riel);
- удалён повторяющийся значок :bug (Jaapio);
- удалена повторяющаяся запись из конвейера сборки (Mike van Riel);
- удалено Zend Serialiser и StdLib (Mike van Riel);
- устранена зависимость ОС от папки поставщика (Mike van Riel);
- наш собственный объект Uri удалён (Mike van Riel);
- Parse и TransformCommand удалены (Mike van Riel);
- pr и lable удалены из рабочего процесса задач (Jaapio);
- дескрипторы типов удалены (Mike van Riel);
- ненужные классы исключений удалены (Mike van Riel);
- функция и тест удалены за ненадобностью (Mike van Riel);
- интерфейс удалён за ненадобностью (Mike van Riel);
- ненужное свойство удалено (Mike van Riel);
- настройки, исправление линтинга и один тест удалены (Mike van Riel);
- обходное решение для создания проектов в других папках удалено (Mike van Riel).
Изменения документации:
- все 404 перенаправляются на /latest (Mike van Riel);
- docroot всегда переходит на /latest (Mike van Riel);
- исправлена ссылка на Graphviz (Mike van Riel);
- CONTRIBUTING.md обновлён с учётом новых веток и имён репозиториев (Mike van Riel);
- документация о том, как работает конфигурация, обновлена (Mike van Riel);
- шаблон документации обновлён в соответствии с новым стилем (Mike van Riel);
- README обновлён парой ссылок (Mike van Riel);
- обновлены щиты (Mike). Конфигурация
FIXED: #1239: Parseprivate всегда вызывает полный запуск парсинга.
FIXED: Парсинг падает при видимости в виде строки.
FIXED: Сбои маршрутизации в Twig.
FIXED: #1307: Падение парсинга при неизвестном признаке.
FIXED: #1114: Отладка для Twig не была включена.
FIXED: Ошибки не отображались в шаблонах XSL.
FIXED: Удалите повторяющийся разделитель пространства имён в константах, определённых DEFINE.
FIXED: #930: @see и @link не разрешались самостоятельно.
FIXED: #993: Символы UTF-8 в именах файлов не работают в Windows.
FIXED: #790: Наследование в XSL было неправильно зарегистрировано.
FIXED: #713: Phar иногда не работал в Windows из-за путей.
FIXED: Восстановите тесты Behat.
FIXED: #1252: Пространства имён не отображаются в адаптивном шаблоне.
2014/05/17: Версия 2.5.0
FIXED: #1211: Загрузка одного плагина невозможна.
FIXED: #1232: Падения маршрутизации при магическом свойстве признака.
FIXED: #157: Классы не наследуют методы и свойства признаков.
FIXED: #1193: Теги пакетов не наследуются классам.
FIXED: #1229: Тег @method в признаке вызывает исключение.
FIXED: #1196: Некоторые файлы не могут быть скопированы с помощью FileIO.
CHANGED: Улучшена обработка OPcache, аннотации больше не удаляются в PHP 5.5+.
CHANGED: phpdoc.php был переименован в phpdoc; phpdoc.php сохранён для обратной совместимости.
2014/04/01: Версия 2.4.0
FIXED: #1141: Отсутствовал устаревший отчёт в шаблоне Clean.
FIXED: #1191: Комментарии Opcache не были отключены из-за неправильного имени расширения.
FIXED: #1184, #1181: Тег @package на файле не распознавался и не наследовался дочерним элементам.
FIXED: #1180: phpDocumentor аварийно завершает работу, если у @subpackage не установлено имя.
FIXED: #1178: Иногда происходит сбой при создании списка маркеров.
FIXED: #1176: Докблоки не переопределялись в подклассах.
FIXED: #1163: Адаптивные и адаптивные шаблоны Twig не работают по HTTPS.
FIXED: #1158: Шаблоны Clean и Responsive показывают пустое меню пространства имён, когда нет пространств имён.
FIXED: #1134, #1132: Отчёты GraphViz могут аварийно завершиться из-за пустых меток.
FIXED: #1098: Повторно добавлен отсутствующий файл Javascript.
FIXED: #1037: IE не понравился пустой якорь.
FIXED: #152: @internal и @ignore вели себя не так, как ожидалось.
FIXED: Уведомления Javascript в Clean после обновления jQuery.
ADDED: #1141: Устаревший отчёт добавлен в шаблон Clean.
ADDED: #629: Поддержка вариадиков.
CHANGED: #1099, #1101: Заменено собственное компилирование PHAR на box-project.org и исправление проблем в это время.
2014/03/07: Версия 2.3.2
FIXED: #1133: Исправлен подпакет без проверки пакета.
FIXED: #1120: Установлены стабильные версии DOMPDF и ezcDocument в Composer.json.
2014/02/26: Версия 2.3.1
CHANGED: #1128: Минимальная версия Symfony/Console была установлена на 2.3 для поддержки LTS-версии.
FIXED: #1090: По-прежнему существуют проблемы с GraphViz, которые теперь исправлены и подтверждены.
FIXED: #1131: Неустранимая ошибка на ConstantConverter при использовании шаблона на основе XML.
2014/02/16: Версия 2.3
ADDED: Поддержка записи файлов PDF с использованием шаблона Twig путём добавления средства записи PDF.
ADDED: Дополнительная документация по типам, запуску phpDocumentor, тегу @var.
ADDED: Поддержка сортировки списков с помощью Twig и XSLT.
ADDED: Базовая поддержка создания справочной документации с документами ReST.
CHANGED: Заменена собственная сборка phar библиотекой с https://box-project.github.io/.
FIXED: #1090: Проблемы с GraphViz, где глобальное пространство имён приводило к тому, что GraphViz не генерировался.
FIXED: #1037 от @siad007: если кэш опкодов включён для CLI, то аннотации удаляются.
FIXED: #1031: Исправлено наследование для сводки, описания, тегов и способа работы @inheritdoc.
FIXED: Добавление нескольких модульных тестов.
FIXED: Очищен код для удаления предупреждений и ошибок.
FIXED: #1111: Бесконечный цикл возникал во время обработки глобальных констант.
FIXED: Аварийное завершение работы, которое происходило при построении дерева пакетов. Сбой при нераспознавании интерфейса.
Исправлено:
- XSLTCache-расширение нельзя было использовать вместо XSLTProcessor из-за постороннего typehint.
- #1110: Сбой при неполном определении define.
- #949: @inheritdoc не работает с интерфейсами.
2013/11/23: Версия 2.2
-----------------------
Добавлено:
- Информация о том, как сделать пожертвование в phpDocumentor через gittip.
- Профилирующая информация и процесс.
Изменено:
- Переместили код документации внешних классов в собственный маршрутизатор.
- #1080: Заменили зависимость от MarkDownExtra на Parsedown.
- Переписали много документации; работа всё ещё продолжается.
Исправлено:
- #720: Во внешней документации класса добавлялся ../files.
- #932: Теги задач не отображались в шаблонах Twig.
- #1049: Аргументы, передаваемые по ссылке, не отображались как переданные по ссылке.
- #1075: Предотвратили перенос вывода в консоли Windows.
- Убрали код на основе сообщений непрерывной интеграции.
- Проблемы с часовым поясом на некоторых машинах.
- Различные проблемы в нескольких шаблонах.
2013/09/28: Версия 2.1
-----------------------
Добавлено:
- Новая опция cli «log», чтобы указать phpDocumentor путь для записи в журнал.
- Теперь можно указывать уровень детализации в журнале.
- Поддержка XSLCache — замена ext/xsl.
- Можно указать локаль в конфигурации.
- Немецкая локализация сообщений об ошибках.
- Возможность вставлять файлы Markdown в определённые точки выводимой документации (частичные).
- Устаревший тег теперь регистрирует номер версии, с которой связанный элемент был объявлен устаревшим.
- Показывают, какие трейты используются классом.
- Ссылка на трейты, используемые классом.
- Отображение трейтов с их методами и свойствами.
Изменено:
- phpDocumentor теперь проверяет требования к преобразованию в начале приложения (#148).
Исправлено:
- Фатальная ошибка с некоторыми проверками старого стиля.
- Ошибки команды Template:list из-за неправильного пути.
- Отчёт о проблемах Checkstyle показывал только ошибки самого файла, а не подэлементов (#1046).
- Проверка на допустимость типов возвращаемых значений.
- Проверка допустимости параметров.
- Фатальная ошибка, когда родительский интерфейс отсутствует в проекте.
- Команда Template:list не выдаёт ошибку.
- XML-вывод корректно отображает @see, @link, @version.
- В XML-выводе больше не происходит сбой при специальных символах.
- Неправильный код ошибки для типа возврата.
- Функции в адаптивном шаблоне Twig теперь разворачиваются, чтобы показать полное содержимое.
- Константы в адаптивном шаблоне Twig теперь разворачиваются, чтобы показать полное содержимое.
- Использование амперсанда в типе @param больше не вызывает фатальную ошибку (не рекомендуется!).
Удалено:
2013/08/08: Версия 2.0.1
-------------------------
Исправлено:
- Созданные phar-файлы нельзя было установить как исполняемые и запустить.
- Недостающие DocBlocks на уровне файлов не обнаруживались.
- Классы и пространства имён не генерировались в Windows.
- Выбрасывались уведомления с чистым шаблоном.
- Расчёты путей в Windows выполнялись неправильно.
2013/08/03: Версия 2.0.0
-------------------------
Добавлено:
- Режим презентации для фильтра Twig маршрутизатора, позволяет использовать разные представления.
- StandardRouter теперь также поддерживает генерацию путей для страниц документации файлов.
- Тег версии теперь обрабатывается в дескрипторах.
Исправлено:
- Сгенерированные пути в писателе Twig были небезопасны для Windows.
- Незначительные изменения в дескрипторе.
- Наследование было нарушено из-за ошибочного слияния.
- Амперсанды в теге. Исправления:
- Наследование методов в интерфейсах было нарушено.
- Ко всем элементам были добавлены внутренние и игнорируемые теги из-за ошибки при фильтрации.
- Не функционировала обработка внутренних встроенных тегов @internal.
- Возникала фатальная ошибка, когда аргумент в теге @method не имел типа.
- Директивы логирования в файле конфигурации не выполнялись.
Изменения:
- При установке Composer папка шаблонов будет vendor/phpdocumentor/templates, а не data/templates.
- Включённый ProgressHelper был заменён новым ProgressHelper компонентов Symfony Console (https://github.com/symfony/symfony/pull/3501).
Удаления:
- Установщик удалён; оказался слишком ненадёжным.
Устарело:
- Ранее общие активы могли находиться в папке /data; это излишне усложняло обработку шаблонов и интеграцию с Composer. Теперь общие активы перемещены внутрь шаблонов, и когда шаблон запрашивает общие активы, он фактически запрашивает файлы из абстрактного шаблона. Использование атрибута source с преобразованием, которое не имеет прямой ссылки на шаблон, будет удалено в версии 3.0; до этого момента код будет вызывать предупреждения E_USER_DEPRECATED.
2013/07/12: Версия 2.0.0b7
Исправления:
- В консоли браузера появлялось предупреждение «Аргумент значения области просмотра «device-width;» для ключа «ширина» недействителен и был проигнорирован. Обратите внимание, что «;» не является разделителем в значениях области просмотра. Список должен быть разделён запятыми».
- Отсутствовал файл VERSION в архиве phar, что приводило к сбою.
- Элементы с тегом @ignore не фильтровались.
- Устаревшие элементы теперь зачёркнуты в обзоре классов.
- Ссылка @see не отображалась и не интерпретировалась.
- Ссылка @uses не отображалась и не интерпретировалась.
- Тип ответа не отображался с магическими методами.
- Аргументы не отображались с магическими методами.
- Тип не отображался с волшебными свойствами.
- Магические методы отсутствовали на боковой панели.
- Проблемы со стандартами кодирования.
- Несколько проблем с документацией.
- Ошибка Windows, при которой косые черты каталога были представлены неправильно.
- Когда файл содержит несколько ошибок, отображается только первая.
- Генерация нового шаблона приводила к фатальной ошибке.
- Сгенерированные шаблоны не содержали строку преобразования для их structure.xml.
- Связывание с функциями.
- Связывание с константами.
- Связывание со свойствами.
- Связывание с методами.
- Корневые элементы с одинаковым коротким именем и файлом, но в другом пространстве имён, перезаписывали друг друга.
Добавления:
Изменения:
- Рефакторинг сборки тегов в дескрипторы, чтобы они работали так же, как и другие дескрипторы.
- Свойства не будут выдавать ошибку относительно отсутствующей сводки, если у них есть тег @var с описанием.
2013/06/23: Версия 2.0.0b6
Дополнения:
- Изменена конфигурация Travis для тестирования с 5.5.
Исправления:
-
Пакеты не индексировались и отображались правильно.
-
Описания @var не отображались как сводка, если сводка отсутствовала для свойства.
-
Добавлена статическая метка для свойства в адаптивном шаблоне.
-
Выравнивание тегов в табличном представлении.
-
Информация о реакции отсутствовала в описании метода.
-
Средство просмотра исходного кода в новом чёрном шаблоне.
-
Волшебные методы теперь отображаются и наследуются в представлении класса для адаптивного шаблона Twig.
-
Волшебные свойства теперь отображаются и наследуются в представлении класса для адаптивного шаблона Twig.
-
Markdown-ограждение в адаптивных и адаптивных шаблонах Twig теперь правильно делает отступы для примеров кода. Изменённое:
-
Глубокая ссылка не должна отображаться для участников без местоположения.
-
PhpDocumentor теперь устанавливает лимит памяти на -1, чтобы предотвратить проблемы из-за ограниченного использования памяти.
-
Увеличен максимальный предел рекурсии с 5000 до 10000, так как всё ещё сообщалось об ошибках.
Удалено:
-
Бинарный файл /bin/parse.php
, его функция выполняется phpdoc project:parse
.
-
Бинарный файл /bin/transform.php
, его функция выполняется phpdoc project:transform
.
2013/06/21: Версия 2.0.0b5
Исправленное:
-
Корневое пространство имён было названо global
в обзорах.
-
Пустая запись Global ('\')
указывала на несуществующий default.html в индексе.
-
Теперь тег показывает номер версии.
-
Фатальная ошибка, когда родительский интерфейс не может быть разрешён в этом проекте.
-
Меню документации API остаётся пустым.
-
Родители интерфейса теперь ссылаются на остальную документацию.
-
Наследование методов, констант и свойств не было правильно распознано; теперь это исправлено.
-
Когда аргумент метода имеет подсказку типа, но нет тега @param, тогда подсказка типа будет показана.
-
Исправлена фатальная ошибка в шаблонах на основе XSL, когда интерфейс расширяет другой.
2013/06/16: Версия 2.0.0b4
Исправленное:
-
Исправлены фатальные ошибки, возникающие при наличии ошибки в константе.
-
Исправлены фатальные ошибки, которые возникают в некоторых случаях с методом getError().
-
Рефакторинг Builder в Assemblers для уменьшения технического долга.
-
Реорганизован ProjectDescriptor Builder, чтобы отделить сборку от фильтрации и проверки.
-
Введён компонент Symfony Validator для проверки элементов.
-
Введён ZF2 Filter компонент для фильтрации элементов (например, с помощью @internal).
2013/06/14: Версия 2.0.0b3
Исправленное:
-
Использование тега @uses приводит к фатальной ошибке во время выполнения.
-
Ошибки теперь отображаются в отчёте об ошибках шаблона responsive-twig.
-
Количество ошибок на индексной странице шаблона responsive-twig восстановлено.
-
Вывод Checkstyle теперь работает должным образом.
-
Шаблон new-black не работал из-за проблемы с капитализацией в Writer исходного кода.
-
Все шаблоны обновлены для генерации structure.xml.
-
Исправлена фатальная ошибка, возникающая, когда свойство, константа или коллекция методов содержит нулевое значение.
-
Исправлено несколько ошибок в шаблоне Old Ocean.
-
Удалён неработающий вызов ведения журнала из Xsl writer.
-
Несколько уведомлений PHP.
2013/06/09: Версия 2.0.0b2
Исправленное:
-
Пакет не мог быть установлен для констант, что приводило к фатальной ошибке.
-
Стандартный шаблон по-прежнему был отзывчивым, а не responsive-twig.
2013/06/09: Версия 2.0.0b1
Тринадцатая альфа phpDocumentor содержит окончательную функциональность для версии 2.0. Было приложено много усилий, чтобы убедиться, что API, структура объектов и механизм плагинов будут оставаться обратно совместимыми до версии 3.0.
Функции были изменены, удалены и добавлены, что делает этот невероятно большой разрыв обратной совместимости по сравнению с 2.0.0a13.
Важно: если вы написали собственный шаблон на основе XSL; пожалуйста, измените template.xml, чтобы сначала сгенерировать вывод XML, добавив преобразование с помощью XmlAst writer. Пожалуйста, посмотрите на наши существующие шаблоны для примера.
Важно: пожалуйста, создайте проблему для каждой сломанной части функциональности. Мы приложили все усилия, чтобы не допустить появления ошибок, но из-за больших изменений некоторые могут возникнуть.
В следующем списке мы попытались исчерпывающе задокументировать список изменений и их влияние. Из-за размера рефакторинга практически невозможно составить 100% точный список. Пожалуйста, свяжитесь с нами, если у вас есть вопросы; веб-сайт https://www.phpdoc.org описывает различные методы.
Добавленное:
- Twig Writer.
- Xml Writer.
- Компонент Router для предоставления местоположений для различных схем URL.
- Responsive-twig шаблон.
- Больше тестов.
- Статистика регистрируется в журнале. Добавлено:
- Компонент компилятора, который добавляет возможность внедрять проходы компилятора в различных точках.
- Линкер для создания объектных связей между различными элементами.
- Индексы, содержащие предварительно сгенерированные списки, чтобы ускорить генерацию шаблонов.
- Больше модульных тестов.
Исправлено:
- Определить преобразования в phpdoc.xml.
- Определить несколько шаблонов в phpdoc.xml.
- Производительность улучшена за счёт пересмотра наследования под другим углом.
- Различные мелкие и неназванные ошибки.
Изменено:
- Наследование перемещено из поведения в дескрипторы.
- Временно удалён устаревший отчёт.
- Целевой параметр парсера теперь принимает только папку.
- Различные улучшения производительности.
- Поддержка Doctrine перемещена в собственный поставщик услуг.
- Переписаны зависимости и схема внедрения, чтобы улучшить DIC.
- Граф объектов записывается в различные папки кеша в каталоге с именем «build» по умолчанию.
- Кеш генерируется Zend\Cache.
- Команды перемещены в соответствующий компонент.
- Парсер повышен до поставщика услуг.
- Трансформатор повышен до поставщика услуг.
- Команда синтаксического анализа подготовлена к интернационализации.
- Конфигурация шаблона анализируется с помощью JmsSerializer.
- Все журналы теперь соответствуют PSR-3.
- Убрана документация для компонентов, которые всё ещё находятся в разработке.
- Обновлена документация по существующей функциональности.
Устарело: Поведения выполняются только для писателя XmlAst.
BC-Break:
- Валидаторы перемещены в конструктор дескрипторов и реорганизованы для интернационализации.
- Парсер генерирует граф объектов, а не XML (structure.xml, теперь используйте писатель XmlAst для вывода XML).
- Плагин заменён поставщиками услуг.
Опубликовать ( 0 )