documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Published 20 hours ago • verified publisher icon php-http

Use phpDocumentor

Open sagikazarmark opened this issue 10 years ago • 6 comments

Do we want to use phpDocumentor?

@mekras raised the idea.

Honestly, I am not sure it is even possible given that the project is separated into several repos, but would be nice to have.

sagikazarmark avatar Nov 11 '15 10:11 sagikazarmark

I prefer http://www.apigen.org/.

mekras avatar Nov 11 '15 11:11 mekras

Looks great.

sagikazarmark avatar Nov 11 '15 11:11 sagikazarmark

myself i use an IDE to develop, so i never look at generated docs. but if somebody wants to set apigen / phpdocumentor up on the website, i have nothing against. i do appreciate good phpdoc on our code, so it can't hurt.

dbu avatar Nov 11 '15 12:11 dbu

@mekras how does phpdoc/apigen behave with symfony-like file headers. Actually I decided to remove them as I saw no real added value.

sagikazarmark avatar Nov 11 '15 12:11 sagikazarmark

apigen is very tolerant to headers. phpdoc requires both (starting with "/**"), and requires at least summary in each header.

mekras avatar Nov 11 '15 12:11 mekras

I usually try to write PHPDoc comments following the phpDocumentor rules, because they are well described and more strict. So these comments can be used by various tools, not only by phpdoc/apigen (e. g. IDEs).

mekras avatar Nov 11 '15 12:11 mekras