How generate phpDoc html from PhpStorm

phpstorm phpdoc
Artem Chernov picture Artem Chernov · Mar 25, 2016 · Viewed 13.1k times · Source

I've not found how generate html format for phpDoc from PhpStorm IDE.

Or should I only use console for this this task, e.g. like this:

$ phpdoc -d|-f <PATH> -t <PATH> [parameters]

Answer

LazyOne picture LazyOne · Mar 25, 2016

  1. PhpStorm does not have built-in support for PHPDoc or any other doc system (ApiDoc, Doxygen etc) in terms of generating final documentation files.

  2. PhpStorm has External Tools functionality exactly for such situations.

  3. Or you can use any build system (e.g. Phing based on Ant / Gulp / Grunt (both require Node.js) or alike) and create such task there (PhpStorm supports all 3 of them).

Related questions

How to change the default author in PhpStorm for PHPDoc

I search for a moment a way to change the name and mail used by PHPDoc in PhpStorm when you use the "autocomplete" by pressing Enter after typing /** just before a class or a function. Example : /** * Class DepartmentType * * @author Foo …

Read More
How to update and generate DocBlock for the entire project in PhpStorm?

I have set up code inspection for php doc blocks, so now I will get warning if they are missing or incomplete. When I have one class open, I can use Code > Generate > PhpDocBlocks to generate them or …

Read More
PHPStorm: correct PHPDoc for a Collection of Objects?

I'm using the PHPStorm IDE, and run into trouble when I run the code inspection. I have a method which returns a collection of objects. The Collection itself is an object, which has its own methods, and implements the Traversable …

Read More