Skip to content

Commit c18a557

Browse files
committed
Add phpdocs with internal
1 parent 7ef31fe commit c18a557

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

system/defines.php

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,63 +67,83 @@
6767
unset($path);
6868

6969
// INTERNAL: Do not use!
70+
/**
71+
* @internal
72+
*/
7073
define('USER_DIR', GRAV_WEBROOT . '/' . GRAV_USER_PATH . '/');
74+
/**
75+
* @internal
76+
*/
7177
define('CACHE_DIR', (!preg_match('`^(/|[a-z]:[\\\/])`ui', GRAV_CACHE_PATH) ? GRAV_ROOT . '/' : '') . GRAV_CACHE_PATH . '/');
7278

7379
// DEPRECATED: Do not use!
7480
/**
81+
* @internal
7582
* @deprecated
7683
*/
7784
define('CACHE_PATH', GRAV_CACHE_PATH . DS);
7885
/**
86+
* @internal
7987
* @deprecated
8088
*/
8189
define('USER_PATH', GRAV_USER_PATH . DS);
8290
/**
91+
* @internal
8392
* @deprecated
8493
*/
8594
define('ROOT_DIR', GRAV_ROOT . DS);
8695
/**
96+
* @internal
8797
* @deprecated
8898
*/
8999
define('ASSETS_DIR', GRAV_WEBROOT . '/assets/');
90100
/**
101+
* @internal
91102
* @deprecated
92103
*/
93104
define('IMAGES_DIR', GRAV_WEBROOT . '/images/');
94105
/**
106+
* @internal
95107
* @deprecated
96108
*/
97109
define('ACCOUNTS_DIR', USER_DIR . 'accounts/');
98110
/**
111+
* @internal
99112
* @deprecated
100113
*/
101114
define('PAGES_DIR', USER_DIR . 'pages/');
102115
/**
116+
* @internal
103117
* @deprecated
104118
*/
105119
define('DATA_DIR', USER_DIR . 'data/');
106120
/**
121+
* @internal
107122
* @deprecated
108123
*/
109124
define('PLUGINS_DIR', USER_DIR . 'plugins/');
110125
/**
126+
* @internal
111127
* @deprecated
112128
*/
113129
define('THEMES_DIR', USER_DIR . 'themes/');
114130
/**
131+
* @internal
115132
* @deprecated
116133
*/
117134
define('SYSTEM_DIR', (!preg_match('`^(/|[a-z]:[\\\/])`ui', GRAV_SYSTEM_PATH) ? GRAV_ROOT . '/' : '') . GRAV_SYSTEM_PATH . '/');
118135
/**
136+
* @internal
119137
* @deprecated
120138
*/
121139
define('LIB_DIR', SYSTEM_DIR . 'src/');
122140
/**
141+
* @internal
123142
* @deprecated
124143
*/
125144
define('VENDOR_DIR', GRAV_ROOT . '/vendor/');
126145
/**
146+
* @internal
127147
* @deprecated
128148
*/
129149
define('LOG_DIR', (!preg_match('`^(/|[a-z]:[\\\/])`ui', GRAV_LOG_PATH) ? GRAV_ROOT . '/' : '') . GRAV_LOG_PATH . '/');

0 commit comments

Comments
 (0)