API populateCanonicalUrl(), setCanonicalUrl(), getCanonical() are now deprecated and should not be used

This commit is contained in:
Robbie Averill 2019-08-15 11:11:38 +12:00
parent 0e922895f2
commit 9185b49cc5

View File

@ -270,6 +270,8 @@ class DocumentationPage extends ViewableData
/** /**
* Determine and set the canonical URL for the given record, for example: dev/docs/en/Path/To/Document * Determine and set the canonical URL for the given record, for example: dev/docs/en/Path/To/Document
*
* @deprecated 2.1.0 This method is no longer used.
*/ */
public function populateCanonicalUrl() public function populateCanonicalUrl()
{ {
@ -371,6 +373,7 @@ class DocumentationPage extends ViewableData
/** /**
* Set the canonical URL to use for this page * Set the canonical URL to use for this page
* *
* @deprecated 2.1.0 This method is no longer used.
* @param string $canonicalUrl * @param string $canonicalUrl
* @return $this * @return $this
*/ */
@ -386,6 +389,7 @@ class DocumentationPage extends ViewableData
* Get the canonical URL to use for this page. Will trigger discovery * Get the canonical URL to use for this page. Will trigger discovery
* via {@link DocumentationPage::populateCanonicalUrl()} if none is already set. * via {@link DocumentationPage::populateCanonicalUrl()} if none is already set.
* *
* @deprecated 2.1.0 This method is no longer used.
* @return string * @return string
*/ */
public function getCanonicalUrl() public function getCanonicalUrl()