From dd9ba3eb542eb98d69d03faa33081604d905d674 Mon Sep 17 00:00:00 2001
From: John Was <janek.jan@gmail.com>
Date: Tue, 11 Mar 2014 16:27:17 +0100
Subject: [PATCH] add phpdoc comments and updated readme.md

---
 readme.md                      |  5 +++++
 src/Faker/Provider/Barcode.php | 10 ++++++++++
 2 files changed, 15 insertions(+)

diff --git a/readme.md b/readme.md
index 1c81a696..8a479054 100644
--- a/readme.md
+++ b/readme.md
@@ -226,6 +226,11 @@ Each of the generator properties (like `name`, `address`, and `lorem`) are calle
     imageUrl($width, $height)   // 'http://lorempixel.com/800/600/'
     imageUrl($width, $height, $category) // 'http://lorempixel.com/800/600/person/'
 
+### `Faker\Provider\Barcode`
+
+    ean13          // '4006381333931'
+    ean8           // '73513537'
+
 ## Unique and Optional modifiers
 
 Faker provides two special providers, `unique()` and `optional()`, to be called before any provider. `optional()` can be useful for seeding non-required fields, like a mobile telephone number ; `unique()` is required to populate fields that cannot accept twice the same value, like primary identifiers.
diff --git a/src/Faker/Provider/Barcode.php b/src/Faker/Provider/Barcode.php
index 105fcad2..c5d88000 100644
--- a/src/Faker/Provider/Barcode.php
+++ b/src/Faker/Provider/Barcode.php
@@ -25,11 +25,21 @@ class Barcode extends \Faker\Provider\Base
         return implode('', $code) . $checksum;
     }
 
+    /**
+     * Get a random EAN13 barcode.
+     * @return string
+     * @example '4006381333931'
+     */
     public function ean13()
     {
         return $this->ean(13);
     }
 
+    /**
+     * Get a random EAN8 barcode.
+     * @return string
+     * @example '73513537'
+     */
     public function ean8()
     {
         return $this->ean(8);