Add default values to method annotations

hydephp · Feb 5, 2023 · 9fa983c · 9fa983c
1 parent af2e193
commit 9fa983c
Showing 1 changed file with 10 additions and 10 deletions.
diff --git a/packages/framework/src/Hyde.php b/packages/framework/src/Hyde.php
@@ -24,15 +24,15 @@
  * @copyright 2022 Caen De Silva
  * @license MIT License
  *
- * @method static string path(string $path = '')
+ * @method static string path(string $path = '') $basePath
  * @method static string vendorPath(string $path = '')
  * @method static string pathToAbsolute(string $path)
  * @method static string pathToRelative(string $path)
  * @method static string getModelSourcePath(string $model, string $path = '')
- * @method static string getBladePagePath(string $path = '')
- * @method static string getMarkdownPagePath(string $path = '')
- * @method static string getMarkdownPostPath(string $path = '')
- * @method static string getDocumentationPagePath(string $path = '')
+ * @method static string getBladePagePath(string $path = '') "$basePath/_pages"
+ * @method static string getMarkdownPagePath(string $path = '') "$basePath/_pages"
+ * @method static string getMarkdownPostPath(string $path = '') "$basePath/_posts"
+ * @method static string getDocumentationPagePath(string $path = '') "$basePath/_docs"
  * @method static string sitePath(string $path = '')
  * @method static string mediaPath(string $path = '')
  * @method static string siteMediaPath(string $path = '')
@@ -46,11 +46,11 @@
  * @method static string trimSlashes(string $string)
  * @method static HtmlString markdown(string $text, bool $stripIndentation = false)
  * @method static string currentPage()
- * @method static string getBasePath()
- * @method static string getSourceRoot()
- * @method static string getOutputDirectory()
- * @method static string getMediaDirectory()
- * @method static string getMediaOutputDirectory()
+ * @method static string getBasePath() $basePath
+ * @method static string getSourceRoot() ''
+ * @method static string getOutputDirectory() '_site'
+ * @method static string getMediaDirectory() '_media'
+ * @method static string getMediaOutputDirectory() '_site/media'
  * @method static Features features()
  * @method static FileCollection files()
  * @method static PageCollection pages()