search

fuel / email

Fuel PHP Framework - Fuel v1.x Email library
60 stars 38 forks source link

Big phpdoc fixes patch #44

Closed SCIF closed 11 years ago

SCIF commented 11 years ago

Now you can use chaining normally by ide's autocompletion. Some other small phpdoc sugar. Fixed some typos.

WanWizard commented 11 years ago

There should not be a @return static in there, you only use that when the method returns new static();

SCIF commented 11 years ago

Just put it here — http://youtrack.jetbrains.com/issue/WI-16587

In fact «self» is not supported by most populars IDEs :( Netbeans and Aptana just ignores that setting like it's absent. Just will wait some desicion from IDEA. My suggestion — http://youtrack.jetbrains.com/issue/WI-16587#comment=27-583159

frankdejonge commented 11 years ago

I thought the correct formatting was @return $this ?

WanWizard commented 11 years ago

Nope, not according to the official PHPDOC docs. But most IDE's seem to use that.

SCIF commented 11 years ago

Ohm. Very interesting — https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#keyword

SCIF commented 11 years ago

Seems like php semantic ($this, static, self) will become phpdoc standart soon.

WanWizard commented 11 years ago

I think static and self are already in the standard, but $this isn't.

I would recommend to use @return $this, since most IDE's already support that, and the PHPDoc standard is in the making...

SCIF commented 11 years ago

Updated the commit (wow! git push -f works for existence pr).