Browse Source

Improve docblocks of public properties

Nils Adermann 10 years ago
parent
commit
2c43a3bcd0

+ 1 - 1
src/Composer/DependencyResolver/Rule.php

@@ -30,7 +30,7 @@ class Rule
     const RULE_PACKAGE_ALIAS = 13;
 
     /**
-     * The literals this rule consists of.
+     * READ-ONLY: The literals this rule consists of.
      * @var array
      */
     public $literals;

+ 2 - 2
src/Composer/DependencyResolver/RuleSet.php

@@ -23,9 +23,9 @@ class RuleSet implements \IteratorAggregate, \Countable
     const TYPE_LEARNED = 4;
 
     /**
-     * Lookup table for rule id to rule object
+     * READ-ONLY: Lookup table for rule id to rule object
      *
-     * @var array
+     * @var Rule[]
      */
     public $ruleById;
 

+ 1 - 2
src/Composer/Package/BasePackage.php

@@ -45,8 +45,7 @@ abstract class BasePackage implements PackageInterface
     );
 
     /**
-     * The package id, public for fast access in dependency solver
-     * Use getId() unless called extremely frequently.
+     * READ-ONLY: The package id, public for fast access in dependency solver
      * @var int
      */
     public $id;