Maslosoft\Zamm\Decorators\StarRemover::decorate()

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
	public function decorate(&$docComment)
	{
		$docComment = trim($docComment);

		// Remove leading slash
		$docComment = preg_replace('~^/~ms', '', $docComment);

		// Remove trailing slash
		$docComment = preg_replace('~/$~ms', '', $docComment);

		// Remove stars and one space
		$docComment = preg_replace('~^\s*\**~ms', '', $docComment);

		// Remove leading spaces. Other whitespace must be preserved.
		$docComment = preg_replace('~^ {1}~ms', '', $docComment);
	}