<?php declare(strict_types=1);

/**
 * This file is part of the Nette Framework (https://nette.org)
 * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
 */

namespace Nette\PhpGenerator\Traits;


/**
 * @internal
 */
trait CommentAware
{
	private ?string $comment = null;


	public function setComment(?string $val): static
	{
		$this->comment = $val;
		return $this;
	}


	public function getComment(): ?string
	{
		return $this->comment;
	}


	/**
	 * Adds a new line to the comment.
	 */
	public function addComment(string $val): static
	{
		$this->comment .= $this->comment ? "\n$val" : $val;
		return $this;
	}


	public function removeComment(): static
	{
		$this->comment = null;
		return $this;
	}
}