Stack Overflow
Stack Overflow

Questions tagged [phpdocumentor2]

phpDocumentor 2 is a tool that makes it possible to generate documentation directly from your PHP source code

phpDocumentor 2 is a tool that makes it possible to generate documentation directly from your PHP source code. With this you can provide your consumers with more information regarding the functionality embedded within your source and not just what is usable to them from your user interface.

Documentation generated by phpDocumentor 2 does not aim to be a replacement for conventional documentation but is rather supplemental, or reference, documentation.This proves to be useful in the following example situations:

  • Sets of libraries or applications providing an API, such as phpDocumentor 2 itself Frameworks, such as Zend Framework or Symfony
  • Pluggable architectures, such as WordPress or PyroCMS
  • Long-running, complex projects, to help you find the right function or method for the job
68 questions
20
votes
1 answer

PhpDocs: Link to another method in "@deprecated" tag's description?

Is it possible to link to another method/class/property/etc. inside my project inline inside the @deprecated tag? Like this: /** * Method description * @deprecated 1.0 Reason for deprecation, use {@link newMethod()} instead! * @param string $str …
armin
  • 353
  • 1
  • 3
  • 8
16
votes
2 answers

Phpdocumentor looks for custom templates in vendor directory

I need to create custom template for PhpDocumentor. The problem is that paths defined in the template.xml, even when specified as absolute ones, are not resolved correctly. PhpDocumentor looks for them in the vendor directory.