phpDocumentor 2.0 DocBlock на уровне страницы — где это?

У меня есть набор классов, каждый класс в своем файле. Я добавил соответствующие DocBlocks, чтобы не получать ошибок или предупреждений при создании документации. Вот очень упрощенный пример:

<?php
/**
 * Page level description.
 */

/**
 * Short class description.
 *
 * Longer description on what this class is all about.
 */
class Test {
    // a bunch of code
}
?>

Когда я запускаю phpdoc для этого класса, DocBlock уровня страницы нигде не появляется в сгенерированном HTML.

Причина этого, возможно, в том, что версия 2.0 все еще находится в альфа-версии. Может ли кто-нибудь просветить меня относительно того, что мне не хватает, если на самом деле я что-то упускаю?

Кстати, я сделал домашнее задание, пытаясь найти ответ. Я нашел этот пост двухмесячной давности, но он ссылается на более раннюю версию phpDocumentor и не не похоже, что ОП указал, удовлетворительно ли он ответил на вопрос.


phpdoc
person user2016410    schedule 27.01.2013    source источник

Ответы (1)


arrow_upward
1
arrow_downward

[...] DocBlock уровня страницы является первым DocBlock в файле, если он содержит тег @package. [...]

<?php
/**
 * Page-level DocBlock
 * @package pagepackage
 */
/**
 * Define DocBlock
 */
define("ahhhh","Now the Page-level DocBlock is for the page, and the Define DocBlock for the define");
?>

Ссылка: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html

person tauanz    schedule 23.04.2013
comment
У меня такая же проблема. Если я добавлю тег @package, класс, функции и т. д. для этой страницы появятся в документации, но не содержимое DocBlock на уровне страницы. - person Urs; 02.07.2013