Issue #2288507 by er.pushpinderrana: Add documentation to entity type annotation classes to aid developers of entity types

core/lib/Drupal/Core/Entity/Annotation/ConfigEntityType.php

@@ -10,6 +10,14 @@ namespace Drupal\Core\Entity\Annotation;
 /**
  * Defines a config entity type annotation object.
  *
+ * Config Entity type plugins use an object-based annotation method, rather than an
+ * array-type annotation method (as commonly used on other annotation types).
+ * The annotation properties of entity types are found on
+ * \Drupal\Core\Entity\ConfigEntityType and are accessed using
+ * get/set methods defined in \Drupal\Core\Entity\EntityTypeInterface.
+ *
+ * @ingroup entity_api
+ *
  * @Annotation
  */
 class ConfigEntityType extends EntityType {

core/lib/Drupal/Core/Entity/Annotation/ContentEntityType.php

@@ -10,6 +10,14 @@ namespace Drupal\Core\Entity\Annotation;
 /**
  * Defines a content entity type annotation object.
  *
+ * Content Entity type plugins use an object-based annotation method, rather than an
+ * array-type annotation method (as commonly used on other annotation types).
+ * The annotation properties of content entity types are found on
+ * \Drupal\Core\Entity\ContentEntityType and are accessed using
+ * get/set methods defined in \Drupal\Core\Entity\ContentEntityTypeInterface.
+ *
+ * @ingroup entity_api
+ *
  * @Annotation
  */
 class ContentEntityType extends EntityType {

core/lib/Drupal/Core/Entity/Annotation/EntityType.php

@@ -19,7 +19,7 @@ use Drupal\Core\StringTranslation\StringTranslationTrait;
  * \Drupal\Core\Entity\EntityType and are accessed using get/set methods defined
  * in \Drupal\Core\Entity\EntityTypeInterface.
  *
- * @see \Drupal\Core\Entity\Annotation\EntityType
+ * @ingroup entity_api
  *
  * @Annotation
  */