Added some more class comments for the Achievement namespace.

petrepatrasc · Mar 19, 2014 · 08b67f7 · 08b67f7
1 parent 872c3f8
commit 08b67f7
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 3 deletions.
diff --git a/Entity/Achievement/Category.php b/Entity/Achievement/Category.php
@@ -2,15 +2,23 @@
 
 namespace petrepatrasc\BlizzardApiBundle\Entity\Achievement;
 
+/**
+ * Contains the entity definition for achievement categories.
+ * @package petrepatrasc\BlizzardApiBundle\Entity\Achievement
+ */
 class Category
 {
 
     /**
+     * Holds achievement data, but in a minimised format, smaller than the Achievement\Standard definition.
+     *
      * @var Minimised
      */
     protected $minimisedAchievement;
 
     /**
+     * Holds the children of the category.
+     *
      * @var array
      */
     protected $children;

diff --git a/Entity/Achievement/Information.php b/Entity/Achievement/Information.php
@@ -2,16 +2,23 @@
 
 namespace petrepatrasc\BlizzardApiBundle\Entity\Achievement;
 
-
+/**
+ * Contains achievement information data, which is a general overview on all of the achievements available.
+ * @package petrepatrasc\BlizzardApiBundle\Entity\Achievement
+ */
 class Information
 {
 
     /**
+     * The achievements that are currently defined in the system.
+     *
      * @var array
      */
     protected $achievements;
 
     /**
+     * The categories that are currently defined in the system.
+     *
      * @var array
      */
     protected $categories;

diff --git a/Entity/Achievement/Minimised.php b/Entity/Achievement/Minimised.php
@@ -2,21 +2,31 @@
 
 namespace petrepatrasc\BlizzardApiBundle\Entity\Achievement;
 
-
+/**
+ * Minimised information regarding an achievement. It's essentially a smaller version of the Achievement\Standard entity,
+ * but they don't quite have a parent -> child relationship.
+ * @package petrepatrasc\BlizzardApiBundle\Entity\Achievement
+ */
 class Minimised
 {
 
     /**
+     * The title of the achievement.
+     *
      * @var string
      */
     protected $title;
 
     /**
+     * The category ID of the achievement.
+     *
      * @var int
      */
     protected $categoryId;
 
     /**
+     * The achievement ID that is featured by this entry.
+     *
      * @var int
      */
     protected $featuredAchievementId;

diff --git a/Entity/Achievement/Points.php b/Entity/Achievement/Points.php
@@ -2,16 +2,23 @@
 
 namespace petrepatrasc\BlizzardApiBundle\Entity\Achievement;
 
-
+/**
+ * Holds achievement points information.
+ * @package petrepatrasc\BlizzardApiBundle\Entity\Achievement
+ */
 class Points
 {
 
     /**
+     * The total points held.
+     *
      * @var int
      */
     protected $totalPoints;
 
     /**
+     * The category points held.
+     *
      * @var array
      */
     protected $categoryPoints;

diff --git a/Entity/Achievement/Standard.php b/Entity/Achievement/Standard.php
@@ -5,35 +5,51 @@
 
 use petrepatrasc\BlizzardApiBundle\Entity\Icon;
 
+/**
+ * Basic Achievement entity data structure. Holds the most detail regarding a single achievement entry.
+ * @package petrepatrasc\BlizzardApiBundle\Entity\Achievement
+ */
 class Standard
 {
 
     /**
+     * The title of the achievement.
+     *
      * @var string
      */
     protected $title;
 
     /**
+     * The description of the achievement.
+     *
      * @var string
      */
     protected $description;
 
     /**
+     * The ID of the achievement.
+     *
      * @var int
      */
     protected $achievementId;
 
     /**
+     * The ID of the category that the achievement belongs to.
+     *
      * @var int
      */
     protected $categoryId;
 
     /**
+     * The points associated to the achievement.
+     *
      * @var int
      */
     protected $points;
 
     /**
+     * The Icon of the achievement.
+     *
      * @var Icon
      */
     protected $icon;