Completed
Push — master ( f548dd...46b15a )
by Hamish
23s
created
view/SSViewer.php 1 patch
Doc Comments   +15 added lines, -6 removed lines patch added patch discarded remove patch
@@ -370,7 +370,6 @@  discard block
 block discarded – undo
370 370
 	/**
371 371
 	 * Returns the modulus of the numerical position of the item in the data set.
372 372
 	 * The count starts from $startIndex, which defaults to 1.
373
-	 * @param int $Mod The number to perform Mod operation to.
374 373
 	 * @param int $startIndex Number to start count from.
375 374
 	 * @return int
376 375
 	 */
@@ -444,6 +443,10 @@  discard block
 block discarded – undo
444 443
 		$this->underlay = $underlay ? $underlay : array();
445 444
 	}
446 445
 
446
+	/**
447
+	 * @param string $interfaceToQuery
448
+	 * @param string $variableMethod
449
+	 */
447 450
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
448 451
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
449 452
 		if($implementers) foreach($implementers as $implementer) {
@@ -818,7 +821,7 @@  discard block
 block discarded – undo
818 821
 	 * Assign the list of active themes to apply.
819 822
 	 * If default themes should be included add $default as the last entry.
820 823
 	 *
821
-	 * @param array $themes
824
+	 * @param string[] $themes
822 825
 	 */
823 826
 	public static function set_themes($themes = []) {
824 827
 		Config::inst()->remove('SSViewer', 'themes');
@@ -863,7 +866,7 @@  discard block
 block discarded – undo
863 866
 	 *
864 867
 	 * @param $className string - valid class name
865 868
 	 * @param $suffix string
866
-	 * @param $baseClass string
869
+	 * @param string $baseClass string
867 870
 	 *
868 871
 	 * @return array
869 872
 	 */
@@ -893,7 +896,7 @@  discard block
 block discarded – undo
893 896
 	}
894 897
 
895 898
 	/**
896
-	 * @param string|array $templateList If passed as a string with .ss extension, used as the "main" template.
899
+	 * @param string|array $templates If passed as a string with .ss extension, used as the "main" template.
897 900
 	 *  If passed as an array, it can be used for template inheritance (first found template "wins").
898 901
 	 *  Usually the array values are PHP class names, which directly correlate to template names.
899 902
 	 *  <code>
@@ -1246,7 +1249,7 @@  discard block
 block discarded – undo
1246 1249
 	 * @param string $template Template name
1247 1250
 	 * @param mixed $data Data context
1248 1251
 	 * @param array $arguments Additional arguments
1249
-	 * @return string Evaluated result
1252
+	 * @return DBHTMLText Evaluated result
1250 1253
 	 */
1251 1254
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
1252 1255
 		$v = new SSViewer($template);
@@ -1272,6 +1275,9 @@  discard block
 block discarded – undo
1272 1275
 		return $v->process($data, $arguments);
1273 1276
 	}
1274 1277
 
1278
+	/**
1279
+	 * @param string $content
1280
+	 */
1275 1281
 	public function parseTemplateContent($content, $template="") {
1276 1282
 		return $this->getParser()->compileString(
1277 1283
 			$content,
@@ -1301,7 +1307,7 @@  discard block
 block discarded – undo
1301 1307
 	 * Return an appropriate base tag for the given template.
1302 1308
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
1303 1309
 	 *
1304
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
1310
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
1305 1311
 	 * the DOCTYPE declaration.
1306 1312
 	 */
1307 1313
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1342,6 +1348,9 @@  discard block
 block discarded – undo
1342 1348
 	 */
1343 1349
 	protected $cacheTemplate;
1344 1350
 
1351
+	/**
1352
+	 * @param string $content
1353
+	 */
1345 1354
 	public function __construct($content, TemplateParser $parser = null) {
1346 1355
 		if ($parser) {
1347 1356
 			$this->setParser($parser);
Please login to merge, or discard this patch.