1- <?php namespace Config ;
1+ <?php
2+
3+ namespace Config ;
24
35/**
6+ * Paths
7+ *
48 * Holds the paths that are used by the system to
59 * locate the main directories, app, system, etc.
6- * Modifying these allows you to re-structure your application,
10+ *
11+ * Modifying these allows you to restructure your application,
712 * share a system folder between multiple applications, and more.
813 *
914 * All paths are relative to the project's root folder.
1015 */
1116
1217class Paths
1318{
14- /*
15- *---------------------------------------------------------------
19+ /**
20+ * ---------------------------------------------------------------
1621 * SYSTEM FOLDER NAME
17- *---------------------------------------------------------------
22+ * ---------------------------------------------------------------
23+ *
24+ * This must contain the name of your "system" folder. Include
25+ * the path if the folder is not in the same directory as this file.
1826 *
19- * This variable must contain the name of your "system" folder.
20- * Include the path if the folder is not in the same directory
21- * as this file.
27+ * @var string
2228 */
2329 public $ systemDirectory = __DIR__ . '/../../vendor/codeigniter4/framework/system ' ;
2430
25- /*
26- *---------------------------------------------------------------
31+ /**
32+ * ---------------------------------------------------------------
2733 * APPLICATION FOLDER NAME
28- *---------------------------------------------------------------
34+ * ---------------------------------------------------------------
2935 *
3036 * If you want this front controller to use a different "app"
3137 * folder than the default one you can set its name here. The folder
3238 * can also be renamed or relocated anywhere on your getServer. If
33- * you do, use a full getServer path. For more info please see the user guide:
34- * http://codeigniter.com/user_guide/general/managing_apps.html
39+ * you do, use a full getServer path.
3540 *
36- * NO TRAILING SLASH!
41+ * @see http://codeigniter.com/user_guide/general/managing_apps.html
42+ *
43+ * @var string
3744 */
3845 public $ appDirectory = __DIR__ . '/.. ' ;
3946
40- /*
47+ /**
4148 * ---------------------------------------------------------------
4249 * WRITABLE DIRECTORY NAME
4350 * ---------------------------------------------------------------
@@ -47,23 +54,23 @@ class Paths
4754 * need write permission to a single place that can be tucked away
4855 * for maximum security, keeping it out of the app and/or
4956 * system directories.
57+ *
58+ * @var string
5059 */
5160 public $ writableDirectory = __DIR__ . '/../../writable ' ;
5261
53- /*
62+ /**
5463 * ---------------------------------------------------------------
5564 * TESTS DIRECTORY NAME
5665 * ---------------------------------------------------------------
5766 *
5867 * This variable must contain the name of your "tests" directory.
59- * The writable directory allows you to group all directories that
60- * need write permission to a single place that can be tucked away
61- * for maximum security, keeping it out of the app and/or
62- * system directories.
68+ *
69+ * @var string
6370 */
6471 public $ testsDirectory = __DIR__ . '/../../tests ' ;
6572
66- /*
73+ /**
6774 * ---------------------------------------------------------------
6875 * VIEW DIRECTORY NAME
6976 * ---------------------------------------------------------------
@@ -72,6 +79,8 @@ class Paths
7279 * contains the view files used by your application. By
7380 * default this is in `app/Views`. This value
7481 * is used when no value is provided to `Services::renderer()`.
82+ *
83+ * @var string
7584 */
7685 public $ viewDirectory = __DIR__ . '/../Views ' ;
7786}
0 commit comments