Use absolute classnames in docblocks

getkirby · Sep 15, 2019 · 3e63f93 · 3e63f93
1 parent 33e5359
commit 3e63f93
Show file tree

Hide file tree

Showing 83 changed files with 446 additions and 447 deletions.
diff --git a/config/components.php b/config/components.php
@@ -22,7 +22,7 @@
     /**
      * Used by the `css()` helper
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string $url Relative or absolute URL
      * @param string|array $options An array of attributes for the link tag or a media attribute string
      */
@@ -33,8 +33,8 @@
     /**
      * Modify URLs for file objects
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
-     * @param Kirby\Cms\File $file The original file object
+     * @param \Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\File $file The original file object
      * @return string
      */
     'file::url' => function (App $kirby, File $file): string {
@@ -44,10 +44,10 @@
     /**
      * Adapt file characteristics
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
-     * @param Kirby\Cms\File|Kirby\Cms\FileModifications $file The file object
+     * @param \Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\File|\Kirby\Cms\FileModifications $file The file object
      * @param array $options All thumb options (width, height, crop, blur, grayscale)
-     * @return Kirby\Cms\File|Kirby\Cms\FileVersion
+     * @return \Kirby\Cms\File|\Kirby\Cms\FileVersion
      */
     'file::version' => function (App $kirby, $file, array $options = []) {
         if ($file->isResizable() === false) {
@@ -82,7 +82,7 @@
     /**
      * Used by the `js()` helper
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string $url Relative or absolute URL
      * @param string|array $options An array of attributes for the link tag or a media attribute string
      */
@@ -93,7 +93,7 @@
     /**
      * Add your own Markdown parser
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string $text Text to parse
      * @param array $options Markdown options
      * @param bool $inline Whether to wrap the text in `<p>` tags
@@ -116,7 +116,7 @@
     /**
      * Add your own SmartyPants parser
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string $text Text to parse
      * @param array $options SmartyPants options
      * @return string
@@ -138,7 +138,7 @@
     /**
      * Add your own snippet loader
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string|array $name Snippet name
      * @param array $data Data array for the snippet
      * @return string|null
@@ -165,11 +165,11 @@
     /**
      * Add your own template engine
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string $name Template name
      * @param string $type Extension type
      * @param string $defaultType Default extension type
-     * @return Kirby\Cms\Template
+     * @return \Kirby\Cms\Template
      */
     'template' => function (App $kirby, string $name, string $type = 'html', string $defaultType = 'html') {
         return new Template($name, $type, $defaultType);
@@ -178,7 +178,7 @@
     /**
      * Add your own thumb generator
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string $src The root of the original file
      * @param string $dst The root to the desired destination
      * @param array $options All thumb options that should be applied: `width`, `height`, `crop`, `blur`, `grayscale`
@@ -198,7 +198,7 @@
     /**
      * Modify all URLs
      *
-     * @param Kirby\Cms\App $kirby Kirby instance
+     * @param \Kirby\Cms\App $kirby Kirby instance
      * @param string $path URL path
      * @param array|null $options Array of options for the Uri class
      * @param Closure $originalHandler Callback function to the original URL handler with `$path` and `$options` as parameters

diff --git a/config/helpers.php b/config/helpers.php
@@ -16,7 +16,7 @@
  * Helper to create an asset object
  *
  * @param string $path
- * @return Kirby\Cms\Asset
+ * @return \Kirby\Cms\Asset
  */
 function asset(string $path)
 {
@@ -44,7 +44,7 @@ function attr(array $attr = null, $before = null, $after = null)
  * Returns the result of a collection by name
  *
  * @param string $name
- * @return Kirby\Cms\Collection|null
+ * @return \Kirby\Cms\Collection|null
  */
 function collection(string $name)
 {
@@ -246,7 +246,7 @@ function html(string $string = null, bool $keepTags = false)
  * <?= image('some/page/myimage.jpg') ?>
  *
  * @param string $path
- * @return Kirby\Cms\File|null
+ * @return \Kirby\Cms\File|null
  */
 function image(string $path = null)
 {
@@ -382,7 +382,7 @@ function js($url, $options = null)
 /**
  * Returns the Kirby object in any situation
  *
- * @return Kirby\Cms\App
+ * @return \Kirby\Cms\App
  */
 function kirby()
 {
@@ -527,7 +527,7 @@ function option(string $key, $default = null)
  * id or the current page when no id is specified
  *
  * @param string|array ...$id
- * @return Kirby\Cms\Page|null
+ * @return \Kirby\Cms\Page|null
  */
 function page(...$id)
 {
@@ -542,7 +542,7 @@ function page(...$id)
  * Helper to build page collections
  *
  * @param string|array ...$id
- * @return Kirby\Cms\Pages
+ * @return \Kirby\Cms\Pages
  */
 function pages(...$id)
 {
@@ -616,7 +616,7 @@ function timestamp(string $date = null, int $step = null): ?string
 /**
  * Returns the currrent site object
  *
- * @return Kirby\Cms\Site
+ * @return \Kirby\Cms\Site
  */
 function site()
 {