minor #74 clean up docblocks and fix some type hints (xabbuh)

This PR was merged into the 3.0.x-dev branch.

Discussion
----------

clean up docblocks and fix some type hints

Commits
-------

fe7add5 clean up docblocks and fix some type hints

Author: xabbuh

src/Account.php

@@ -18,14 +18,7 @@
  */
 final class Account
 {
-    /**
-     * @var string The unique id or name used to log in to this account
-     */
     private $name;
-
-    /**
-     * @var IRL Canonical home page for the system the account is on
-     */
     private $homePage;
 
     public function __construct(string $name, IRL $homePage)
@@ -36,8 +29,6 @@ public function __construct(string $name, IRL $homePage)
 
     /**
      * Returns the unique id or name used to log in to this account.
-     *
-     * @return string The user name
      */
     public function getName(): string
     {
@@ -46,8 +37,6 @@ public function getName(): string
 
     /**
      * Returns the home page for the system the account is on.
-     *
-     * @return IRL The home page
      */
     public function getHomePage(): IRL
     {
@@ -58,10 +47,6 @@ public function getHomePage(): IRL
      * Checks if another account is equal.
      *
      * Two accounts are equal if and only if all of their properties are equal.
-     *
-     * @param Account $account The account to compare with
-     *
-     * @return bool True if the accounts are equal, false otherwise
      */
     public function equals(Account $account): bool
     {

src/Activity.php

@@ -18,20 +18,9 @@
  */
 final class Activity extends StatementObject
 {
-    /**
-     * @var IRI The Activity's unique identifier
-     */
     private $id;
-
-    /**
-     * @var Definition|null The Activity's {@link Definition}
-     */
     private $definition;
 
-    /**
-     * @param IRI             $id
-     * @param Definition|null $definition
-     */
     public function __construct(IRI $id, Definition $definition = null)
     {
         $this->id = $id;
@@ -40,8 +29,6 @@ public function __construct(IRI $id, Definition $definition = null)
 
     /**
      * Returns the Activity's unique identifier.
-     *
-     * @return IRI The identifier
      */
     public function getId(): IRI
     {
@@ -50,8 +37,6 @@ public function getId(): IRI
 
     /**
      * Returns the Activity's {@link Definition}.
-     *
-     * @return Definition|null The Definition
      */
     public function getDefinition(): ?Definition
     {
@@ -67,8 +52,6 @@ public function equals(StatementObject $object): bool
             return false;
         }
 
-        /** @var Activity $object */
-
         if (!$this->id->equals($object->id)) {
             return false;
         }

src/ActivityProfile.php

@@ -18,9 +18,6 @@
  */
 final class ActivityProfile extends Profile
 {
-    /**
-     * @var Activity The activity
-     */
     private $activity;
 
     public function __construct(string $profileId, Activity $activity)
@@ -32,8 +29,6 @@ public function __construct(string $profileId, Activity $activity)
 
     /**
      * Returns the {@link Activity}.
-     *
-     * @return Activity The activity
      */
     public function getActivity(): Activity
     {

src/ActivityProfileDocument.php

@@ -18,9 +18,6 @@
  */
 final class ActivityProfileDocument extends Document
 {
-    /**
-     * @var ActivityProfile The activity profile
-     */
     private $profile;
 
     public function __construct(ActivityProfile $profile, DocumentData $data)
@@ -30,11 +27,6 @@ public function __construct(ActivityProfile $profile, DocumentData $data)
         $this->profile = $profile;
     }
 
-    /**
-     * Returns the {@link ActivityProfile activity profile}.
-     *
-     * @return ActivityProfile The activity profile
-     */
     public function getActivityProfile(): ActivityProfile
     {
         return $this->profile;

src/Actor.php

@@ -18,17 +18,7 @@
  */
 abstract class Actor extends StatementObject
 {
-    /**
-     * The actor's {@link InverseFunctionalIdentifier inverse functional identifier}
-     *
-     * @var InverseFunctionalIdentifier|null
-     */
     private $iri;
-
-    /**
-     * Name of the {@link Agent} or {@link Group}
-     * @var string|null
-     */
     private $name;
 
     public function __construct(InverseFunctionalIdentifier $iri = null, string $name = null)
@@ -39,8 +29,6 @@ public function __construct(InverseFunctionalIdentifier $iri = null, string $nam
 
     /**
      * Returns the Actor's {@link InverseFunctionalIdentifier inverse functional identifier}.
-     *
-     * @return InverseFunctionalIdentifier|null The inverse functional identifier
      */
     public function getInverseFunctionalIdentifier(): ?InverseFunctionalIdentifier
     {
@@ -49,8 +37,6 @@ public function getInverseFunctionalIdentifier(): ?InverseFunctionalIdentifier
 
     /**
      * Returns the name of the {@link Agent} or {@link Group}.
-     *
-     * @return string|null The name
      */
     public function getName(): ?string
     {
@@ -61,10 +47,6 @@ public function getName(): ?string
      * Checks if another actor is equal.
      *
      * Two actors are equal if and only if all of their properties are equal.
-     *
-     * @param Object $actor The actor to compare with
-     *
-     * @return bool True if the actors are equal, false otherwise
      */
     public function equals(StatementObject $actor): bool
     {

src/AgentProfile.php

@@ -18,9 +18,6 @@
  */
 final class AgentProfile extends Profile
 {
-    /**
-     * @var Agent The agent
-     */
     private $agent;
 
     public function __construct(string $profileId, Agent $agent)
@@ -30,11 +27,6 @@ public function __construct(string $profileId, Agent $agent)
         $this->agent = $agent;
     }
 
-    /**
-     * Returns the agent.
-     *
-     * @return Agent The agent
-     */
     public function getAgent(): Agent
     {
         return $this->agent;

src/AgentProfileDocument.php

@@ -18,9 +18,6 @@
  */
 final class AgentProfileDocument extends Document
 {
-    /**
-     * @var AgentProfile The agent profile
-     */
     private $profile;
 
     public function __construct(AgentProfile $profile, DocumentData $data)
@@ -30,11 +27,6 @@ public function __construct(AgentProfile $profile, DocumentData $data)
         $this->profile = $profile;
     }
 
-    /**
-     * Returns the agent profile.
-     *
-     * @return AgentProfile The agent profile
-     */
     public function getAgentProfile(): AgentProfile
     {
         return $this->profile;

src/Context.php

@@ -18,54 +18,16 @@
  */
 final class Context
 {
-    /**
-     * @var string|null
-     */
     private $registration;
-
-    /**
-     * @var Actor|null
-     */
     private $instructor;
-
-    /**
-     * @var Group|null
-     */
     private $team;
-
-    /**
-     * @var ContextActivities|null
-     */
     private $contextActivities;
-    /**
-     * @var string|null
-     */
     private $revision;
-    /**
-     * @var string|null
-     */
     private $platform;
-
-    /**
-     * @var string|null
-     */
     private $language;
-
-    /**
-     * @var StatementReference|null
-     */
     private $statement;
-
-    /**
-     * @var Extensions|null
-     */
     private $extensions;
 
-    /**
-     * @param string $registration
-     *
-     * @return self
-     */
     public function withRegistration(string $registration): self
     {
         $context = clone $this;
@@ -98,11 +60,6 @@ public function withContextActivities(ContextActivities $contextActivities): sel
         return $context;
     }
 
-    /**
-     * @param string $revision
-     *
-     * @return self
-     */
     public function withRevision(string $revision): self
     {
         $context = clone $this;
@@ -111,11 +68,6 @@ public function withRevision(string $revision): self
         return $context;
     }
 
-    /**
-     * @param string $platform
-     *
-     * @return self
-     */
     public function withPlatform(string $platform): self
     {
         $context = clone $this;
@@ -124,11 +76,6 @@ public function withPlatform(string $platform): self
         return $context;
     }
 
-    /**
-     * @param string $language
-     *
-     * @return self
-     */
     public function withLanguage(string $language): self
     {
         $context = clone $this;
@@ -153,73 +100,46 @@ public function withExtensions(Extensions $extensions): self
         return $context;
     }
 
-    /**
-     * @return string|null
-     */
     public function getRegistration(): ?string
     {
         return $this->registration;
     }
 
-    /**
-     * @return Actor|null
-     */
     public function getInstructor(): ?Actor
     {
         return $this->instructor;
     }
 
-    /**
-     * @return Group|null
-     */
     public function getTeam(): ?Group
     {
         return $this->team;
     }
 
-    /**
-     * @return ContextActivities|null
-     */
     public function getContextActivities(): ?ContextActivities
     {
         return $this->contextActivities;
     }
 
-    /**
-     * @return string|null
-     */
     public function getRevision(): ?string
     {
         return $this->revision;
     }
 
-    /**
-     * @return string|null
-     */
     public function getPlatform(): ?string
     {
         return $this->platform;
     }
 
-    /**
-     * @return string|null
-     */
     public function getLanguage(): ?string
     {
         return $this->language;
     }
 
-    /**
-     * @return StatementReference|null
-     */
     public function getStatement(): ?StatementReference
     {
         return $this->statement;
     }
 
-    /**
-     * @return Extensions|null
-     */
     public function getExtensions(): ?Extensions
     {
         return $this->extensions;