Merge pull request #18017 from akeneo/CPM-742

CPM-742: Add a short description for domain objects
akeneo · Sep 29, 2022 · 039e8b9 · 039e8b9
2 parents db25577 + b412db6
commit 039e8b9
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 0 deletions.
diff --git a/components/identifier-generator/back/src/Domain/Model/Condition/Conditions.php b/components/identifier-generator/back/src/Domain/Model/Condition/Conditions.php
@@ -7,6 +7,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * Condition allowing to apply the identifier generation
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */

diff --git a/components/identifier-generator/back/src/Domain/Model/Delimiter.php b/components/identifier-generator/back/src/Domain/Model/Delimiter.php
@@ -5,6 +5,7 @@
 namespace Akeneo\Pim\Automation\IdentifierGenerator\Domain\Model;
 
 /**
+ * String between each Properties chosen to create the Structure of the identifier
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */

diff --git a/components/identifier-generator/back/src/Domain/Model/IdentifierGeneratorCode.php b/components/identifier-generator/back/src/Domain/Model/IdentifierGeneratorCode.php
@@ -7,6 +7,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * Unique identifier code
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */

diff --git a/components/identifier-generator/back/src/Domain/Model/LabelCollection.php b/components/identifier-generator/back/src/Domain/Model/LabelCollection.php
@@ -7,6 +7,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * The collection of the generator labels by locale
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */

diff --git a/components/identifier-generator/back/src/Domain/Model/Property/AutoNumber.php b/components/identifier-generator/back/src/Domain/Model/Property/AutoNumber.php
@@ -7,6 +7,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * Property to add an auto number to the structure
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */

diff --git a/components/identifier-generator/back/src/Domain/Model/Property/FreeText.php b/components/identifier-generator/back/src/Domain/Model/Property/FreeText.php
@@ -7,6 +7,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * Property to add a free text to the structure
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */

diff --git a/components/identifier-generator/back/src/Domain/Model/Structure.php b/components/identifier-generator/back/src/Domain/Model/Structure.php
@@ -8,6 +8,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * Array of properties used to define the structure of an identifier generator
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */

diff --git a/components/identifier-generator/back/src/Domain/Model/Target.php b/components/identifier-generator/back/src/Domain/Model/Target.php
@@ -7,6 +7,7 @@
 use Webmozart\Assert\Assert;
 
 /**
+ * The attribute code of type identifier that will be impacted by the generation
  * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
  * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */