Использование @package вместо пространства имен в phpDocumentor 2
У меня есть большая библиотека кода, для которой я пытаюсь создать иерархическую документацию. Проект не использует пространства имен, а вместо этого использует @package.
Я только что попытался создать документы в качестве теста из следующего файла с помощью phpDocumentor2:
<?php
/**
* This is a file
* @package JustAn\Example
**/
/**
* Something class
**/
class Something{
function try_this(){
}
}
Хотя в соответствии с документами @пакет JustAn\Пример должен быть эквивалентом пространства имен JustAn\Пример, я обнаружил, что это не так.
Когда я использую пространства имен, результирующая документация выглядит так это:
Когда я использую обозначение @package, результат выглядит следующим образом (даже если он распознает обозначение пакета - это показано на странице с полной информацией о классе):
Я ищу способ получить иерархический результат без необходимости переписывать код для использования "реальных" пространств имен.
2 answers
Проблема в том, что шаблон "чистый" по умолчанию не поддерживает эту функцию. Другие шаблоны (например, "отзывчивый") делают это. Вы можете использовать флаг --template="отзывчивый", чтобы изменить используемый шаблон по умолчанию.
Я вижу, что у вас есть тег пакета в файле docblock, но нет класса docblock. Если вы добавите его в свой блок документов класса, я думаю, он должен сработать.