Skip to content
Snippets Groups Projects
Commit 1fe7829e authored by catch's avatar catch
Browse files

Issue #3209468 by joaopauloc.dev, pooja saraah, joachim: DrupalKernelInterface...

Issue #3209468 by joaopauloc.dev, pooja saraah, joachim: DrupalKernelInterface methods & DrupalKernel::sitePath should document the format of a site path
parent 4aa36600
No related branches found
No related tags found
No related merge requests found
......@@ -224,7 +224,12 @@ class DrupalKernel implements DrupalKernelInterface, TerminableInterface {
protected static $isEnvironmentInitialized = FALSE;
/**
* The site directory.
* The site path directory.
*
* Site path is relative to the app root directory.
* Usually defined as "sites/default".
*
* By default, drupal uses sites/default.
*
* @var string
*/
......
......@@ -74,7 +74,9 @@ public function getContainer();
public function getCachedContainerDefinition();
/**
* Set the current site path.
* Set the current site path directory.
*
* Format: "folder-name/child-folder" usually uses "sites/default".
*
* @param string $path
* The current site path.
......@@ -85,10 +87,10 @@ public function getCachedContainerDefinition();
public function setSitePath($path);
/**
* Get the site path.
* Gets the site path directory.
*
* @return string
* The current site path.
* The current site path directory.
*/
public function getSitePath();
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment