mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-12-26 12:59:31 +00:00
Improved documentation of entity fields
This commit is contained in:
parent
219fbe5fca
commit
f01ec9dbe4
13 changed files with 30 additions and 27 deletions
|
|
@ -43,14 +43,14 @@ trait AdvancedPropertyTrait
|
|||
protected bool $needs_review = false;
|
||||
|
||||
/**
|
||||
* @var string a comma separated list of tags, associated with the part
|
||||
* @var string A comma separated list of tags, associated with the part
|
||||
*/
|
||||
#[Groups(['extended', 'full', 'import', 'part:read', 'part:write'])]
|
||||
#[ORM\Column(type: Types::TEXT)]
|
||||
protected string $tags = '';
|
||||
|
||||
/**
|
||||
* @var float|null how much a single part unit weighs in grams
|
||||
* @var float|null How much a single part unit weighs in grams
|
||||
*/
|
||||
#[Assert\PositiveOrZero]
|
||||
#[Groups(['extended', 'full', 'import', 'part:read', 'part:write'])]
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ use Symfony\Component\Validator\Constraints as Assert;
|
|||
trait InstockTrait
|
||||
{
|
||||
/**
|
||||
* @var Collection|PartLot[] A list of part lots where this part is stored
|
||||
* @var Collection<int, PartLot> A list of part lots where this part is stored
|
||||
*/
|
||||
#[Assert\Valid]
|
||||
#[Groups(['extended', 'full', 'import'])]
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ trait ManufacturerTrait
|
|||
protected ?Manufacturer $manufacturer = null;
|
||||
|
||||
/**
|
||||
* @var string the url to the part on the manufacturer's homepage
|
||||
* @var string The url to the part on the manufacturer's homepage
|
||||
*/
|
||||
#[Assert\Url]
|
||||
#[Groups(['full', 'import', 'part:read', 'part:write'])]
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ use Doctrine\ORM\Mapping as ORM;
|
|||
trait OrderTrait
|
||||
{
|
||||
/**
|
||||
* @var Collection<int, Orderdetail> the details about how and where you can order this part
|
||||
* @var Collection<int, Orderdetail> The details about how and where you can order this part
|
||||
*/
|
||||
#[Assert\Valid]
|
||||
#[Groups(['extended', 'full', 'import'])]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue