Урок - phpDocumentor - генератор документации

Установка phpDoc

phpDocumentor уже долго не обновлялся что привело к отсутствию исправления такой важной ошибки как поддержка кириллицы в UTF-8.

На сайте russianpenguin.ru есть ссылка на архив phpDocumentor c исправленной версией для русских символов в UTF-8. Исправленную и готовой к работе версии phpDocumentor-а можно скачать с github

Если по какми-то причином это вариант не получился - следуйте следующим шагам:

• Переходим сюда и качаем PhpDocumentor.
• Распаковываем.
• Открываем phpdoc.bat. Находим: "SET phpCli=". Заменяем на местоположение файла php.exe

Теперь идем к исправлению багов:

Если вы обратие внимание, на водиржимое файлов - половина css файлов имела формат *.cs, а png — *.pn. Для исправления этого в корне phpDocumentor создаём файл correct.bat, с содержимым:

@Echo Off
for /f "tokens=1,2" %%a in ('dir /s /b *.cs') do ren %%a %%~nxas
for /f "tokens=1,2" %%a in ('dir /s /b *.pn') do ren %%a %%~nxag
for /f "tokens=1,2" %%a in ('dir /s /b *.tp') do ren %%a %%~nxal
@pause

Для поддержки UTF-8:

1. нужно править файл Setup.inc.php. В нем есть метод createDocs, где нужно исправить следующее:

   - if (stristr($ret, "utf-8") !== "")
   + if (stristr($ret, "utf-8") === false)
   {
   	$ret = utf8_decode($ret);
   }

2. Пройтись глобальной заменой по всем (*.*) файлам документатора и заменить

   charset=iso-8859-1'/>

   на

   charset=utf-8'/>

3. Необязательный (имеет значение при выводе мануала в XML)
   Пройтись глобальной заменой по всем (*.*) файлам документатора и заменить

   <?xml version="1.0" encoding="iso-8859-1">

   на

   <?xml version="1.0" encoding="utf-8">