Skip to content
Permalink
Browse files

Add deprecated doc strings.

Fixes #12798
  • Loading branch information
markstory committed Dec 11, 2018
1 parent 53d0934 commit 3db50b4044dc4fdbad6d54cfbeb437f772ffbb3a
Showing with 6 additions and 0 deletions.
  1. +6 −0 src/Mailer/Email.php
@@ -1288,6 +1288,7 @@ public function getTemplate()
*
* @param string|null $layout Layout name or null to not use
* @return $this
* @deprecated 3.7.0 Use $email->viewBuilder()->setLayout() instead.
*/
public function setLayout($layout)
{
@@ -1303,6 +1304,7 @@ public function setLayout($layout)
/**
* Gets layout.
*
* @deprecated 3.7.0 Use $email->viewBuilder()->getLayout() instead.

This comment has been minimized.

Copy link
@markusramsak

markusramsak Dec 11, 2018

All @deprecated notices should be the last comment statement (under @return)?

This comment has been minimized.

Copy link
@markstory

markstory Dec 11, 2018

Author Member

Why?

This comment has been minimized.

Copy link
@markusramsak

markusramsak Dec 11, 2018

Just for consistency.

This comment has been minimized.

Copy link
@dereuromark

dereuromark Dec 11, 2018

Member

As long as there is no sniffer (having autofixer) this is not really worth doing, manuelly.

This comment has been minimized.

Copy link
@markstory

markstory Dec 11, 2018

Author Member

@markusramsak You're welcome to shuffle doc string tags around if you have the interest 😄

This comment has been minimized.

Copy link
@markusramsak

markusramsak Dec 11, 2018

okay - I just noticed an inconsistency (in my eyes) in this commit therefore I wanted to mention it.

* @return string
*/
public function getLayout()
@@ -1432,6 +1434,7 @@ public function viewVars($viewVars = null)
*
* @param string $theme Theme name.
* @return $this
* @deprecated 3.7.0 Use $email->viewBuilder()->setTheme() instead.
*/
public function setTheme($theme)
{
@@ -1448,6 +1451,7 @@ public function setTheme($theme)
* Gets theme to use when rendering.
*
* @return string
* @deprecated 3.7.0 Use $email->viewBuilder()->getTheme() instead.
*/
public function getTheme()
{
@@ -1483,6 +1487,7 @@ public function theme($theme = null)
*
* @param array $helpers Helpers list.
* @return $this
* @deprecated 3.7.0 Use $email->viewBuilder()->setHelpers() instead.
*/
public function setHelpers(array $helpers)
{
@@ -1499,6 +1504,7 @@ public function setHelpers(array $helpers)
* Gets helpers to be used when rendering.
*
* @return array
* @deprecated 3.7.0 Use $email->viewBuilder()->getHelpers() instead.
*/
public function getHelpers()
{

0 comments on commit 3db50b4

Please sign in to comment.
You can’t perform that action at this time.