@uses和@throws没有在phpDocumentor2中解析

时间:2013-07-06 16:38:58

标签: php doctrine phpdoc phpdocumentor2

我正在使用phpDocumentor2为我的代码编译文档。包含@throws和@uses的DocBlocks并没有完全符合我的预期。

具体而言,FQSEN未在文档输出中呈现。

例如

/**
 * Constructs the object and loads data.
 * 
 * This constructor invokes the gatherData and populates the object's instance variables.
 *
 * @uses gatherData() to load in the data associated with this object.
 * @uses load() to populate the data gathered.
 */

...生成

A screenshot of the resulting documentation

请注意,“gatherData()”和“load()”方法名称在输出中没有出现。然而,他们的描述确实如此。

我看到@throws标签有类似的效果。

这是预期的行为吗?我滥用标签吗?

1 个答案:

答案 0 :(得分:2)

如果这些是某些类的方法,则应指定它们,如

@uses SomeClass::gatherData() to load in the data associated with this object.

原始phpdocumentor不支持名称空间,您可能需要切换到phpdocumentor2版本。