Skip to content

Commit b6c0655

Browse files
committed
Clarify rendered docblocks
1 parent 45a7972 commit b6c0655

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

system/View/RendererInterface.php

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ interface RendererInterface
2626
* @param array $options Reserved for 3rd-party uses since
2727
* it might be needed to pass additional info
2828
* to other template engines.
29-
* @param boolean $saveData If true, will save data for use with any other calls,
30-
* if false, will clean the data after displaying the view,
31-
* if not specified, use the config setting.
29+
* @param boolean $saveData Whether to save data for subsequent calls
3230
*
3331
* @return string
3432
*/
@@ -44,9 +42,7 @@ public function render(string $view, array $options = null, bool $saveData = fal
4442
* @param array $options Reserved for 3rd-party uses since
4543
* it might be needed to pass additional info
4644
* to other template engines.
47-
* @param boolean $saveData If true, will save data for use with any other calls,
48-
* if false, will clean the data after displaying the view,
49-
* if not specified, use the config setting.
45+
* @param boolean $saveData Whether to save data for subsequent calls
5046
*
5147
* @return string
5248
*/

system/View/View.php

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,16 @@ public function __construct(ViewConfig $config, string $viewPath = null, FileLoc
152152
* data that has already been set.
153153
*
154154
* Valid $options:
155-
* - cache number of seconds to cache for
156-
* - cache_name Name to use for cache
155+
* - cache Number of seconds to cache for
156+
* - cache_name Name to use for cache
157157
*
158-
* @param string $view
159-
* @param array|null $options
160-
* @param boolean|null $saveData
158+
* @param string $view The view contents
159+
* @param array $options Reserved for 3rd-party uses since
160+
* it might be needed to pass additional info
161+
* to other template engines.
162+
* @param boolean|null $saveData If true, saves data for subsequent calls,
163+
* if false, cleans the data after displaying,
164+
* if null, uses the config setting.
161165
*
162166
* @return string
163167
*/
@@ -272,13 +276,13 @@ public function render(string $view, array $options = null, bool $saveData = nul
272276
* data that has already been set.
273277
* Cache does not apply, because there is no "key".
274278
*
275-
* @param string $view The view contents
276-
* @param array $options Reserved for 3rd-party uses since
277-
* it might be needed to pass additional info
278-
* to other template engines.
279-
* @param boolean $saveData If true, will save data for use with any other calls,
280-
* if false, will clean the data after displaying the view,
281-
* if not specified, use the config setting.
279+
* @param string $view The view contents
280+
* @param array $options Reserved for 3rd-party uses since
281+
* it might be needed to pass additional info
282+
* to other template engines.
283+
* @param boolean|null $saveData If true, saves data for subsequent calls,
284+
* if false, cleans the data after displaying,
285+
* if null, uses the config setting.
282286
*
283287
* @return string
284288
*/

0 commit comments

Comments
 (0)