pdv icon indicating copy to clipboard operation
pdv copied to clipboard

On function comments add the return as well

Open vendion opened this issue 11 years ago • 6 comments

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
 */

vendion avatar May 29 '14 14:05 vendion

For me that is also a lot desired feature.

fogine avatar Jun 22 '14 11:06 fogine

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

tobyS avatar Jun 22 '14 12:06 tobyS

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}}

  • parameter variables

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.

fogine avatar Jun 22 '14 13:06 fogine

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.

tobyS avatar Jun 22 '14 13:06 tobyS

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

swekaj avatar Feb 24 '15 17:02 swekaj

+1

mhz-tamb avatar Nov 03 '15 10:11 mhz-tamb