Improved documentation of entity fields

This commit is contained in:
Jan Böhmer 2023-09-17 12:50:32 +02:00
parent 219fbe5fca
commit f01ec9dbe4
13 changed files with 30 additions and 27 deletions

View file

@ -86,7 +86,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
protected string $comment = '';
/**
* @var string
* @var string The link to the website of an article. Use %PARTNUMBER% as placeholder for the part number.
*/
#[ORM\Column(type: Types::STRING)]
protected string $auto_product_url = '';

View file

@ -40,7 +40,7 @@ abstract class AbstractNamedDBElement extends AbstractDBElement implements Named
use TimestampTrait;
/**
* @var string the name of this element
* @var string The name of this element
*/
#[Assert\NotBlank]
#[Groups(['simple', 'extended', 'full', 'import', 'api:basic:read', 'api:basic:write'])]

View file

@ -40,6 +40,9 @@ use Symfony\Component\Serializer\Annotation\Groups;
#[ORM\MappedSuperclass(repositoryClass: AbstractPartsContainingRepository::class)]
abstract class AbstractPartsContainingDBElement extends AbstractStructuralDBElement
{
/**
* @var Collection|ArrayCollection The parameters of this element
*/
#[Groups(['full'])]
protected Collection $parameters;