Merge pull request #452 from wmde/sparseDocs

More specific return docs in StatementList

Author: Benestar

src/Statement/StatementList.php

@@ -74,7 +74,7 @@ public function getBestStatementPerProperty() {
 	 * Returns the property ids used by the statements.
 	 * The keys of the returned array hold the serializations of the property ids.
 	 *
-	 * @return PropertyId[]
+	 * @return PropertyId[] Array indexed by property id serialization.
 	 */
 	public function getPropertyIds() {
 		$propertyIds = array();
@@ -127,7 +127,7 @@ public function getWithUniqueMainSnaks() {
 	 *
 	 * @param PropertyId $id
 	 *
-	 * @return StatementList
+	 * @return self
 	 */
 	public function getWithPropertyId( PropertyId $id ) {
 		$statementList = new self();
@@ -146,7 +146,7 @@ public function getWithPropertyId( PropertyId $id ) {
 	 *
 	 * @param int|int[] $acceptableRanks
 	 *
-	 * @return StatementList
+	 * @return self
 	 */
 	public function getWithRank( $acceptableRanks ) {
 		$acceptableRanks = array_flip( (array)$acceptableRanks );
@@ -168,7 +168,7 @@ public function getWithRank( $acceptableRanks ) {
 	 *
 	 * @since 2.4
 	 *
-	 * @return StatementList
+	 * @return self
 	 */
 	public function getBestStatements() {
 		$statements = $this->getWithRank( Statement::RANK_PREFERRED );
@@ -189,7 +189,7 @@ public function getBestStatements() {
 	 *
 	 * @since 1.1
 	 *
-	 * @return Snak[]
+	 * @return Snak[] Numerically indexed (non-sparse) array.
 	 */
 	public function getAllSnaks() {
 		$snaks = array();
@@ -206,7 +206,7 @@ public function getAllSnaks() {
 	/**
 	 * @since 2.3
 	 *
-	 * @return Snak[]
+	 * @return Snak[] Numerically indexed (non-sparse) array.
 	 */
 	public function getMainSnaks() {
 		$snaks = array();
@@ -234,6 +234,7 @@ public function toArray() {
 
 	/**
 	 * @see Countable::count
+	 *
 	 * @return int
 	 */
 	public function count() {