tobyS / pdv

PHP Documentor for VIM - Generates PHP docblocks
161 stars 32 forks source link

On function comments add the return as well #10

Open vendion opened 10 years ago

vendion commented 10 years ago

When generation comments of a function with pdv could it also show what the return value is like it does with the @param. So the end result would look something like the following

/**
 * someFunc
 *
 * @param int $x
 * @param int $y
 * @return int $sum
 */
fogine commented 10 years ago

For me that is also a lot desired feature.

tobyS commented 10 years ago

I think it just needs to be added to the corresponding template(s).

fogine commented 10 years ago

Now script parses only function header ( public function set($arg) ), not body of function... In function template, there are available variables: {{indent}} {{scope}} {{static}} {{name}}

On 22. červen 2014 14:44:56, Tobias Schlitt wrote:

I think it just needs to be added to the corresponding template(s).

— Reply to this email directly or view it on GitHub https://github.com/tobyS/pdv/issues/10#issuecomment-46780210.

tobyS commented 10 years ago

Ah, I see. Well, that is some more effort then. I cannot promise to have time for that in the near future. If anyone has, please feel free to issue a pull request.

swekaj commented 9 years ago

If you could also look into adding @throws statements that'd be awesome.

mhz-tamb commented 9 years ago

+1