From ca87a49b277965307124f4d59855143d341ba92f Mon Sep 17 00:00:00 2001
From: "sean.sandy" <sean.sandy@gmail.com>
Date: Wed, 16 Aug 2017 13:09:09 -0400
Subject: [PATCH] codecov badge + docs

---
 .travis.yml            |  2 ++
 README.md              |  5 +++--
 source/DbInterface.php | 19 +++++++++++++------
 tests/source/Db.php    | 30 ++++++++++++++++++++++--------
 4 files changed, 40 insertions(+), 16 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 4263066..60ab303 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -3,9 +3,11 @@ sudo: false
 language: php
 
 php:
+  - 5.5
   - 5.6
   - 7.0
   - 7.1
+  - hhvm
 
 before_script:
   - composer install -n
diff --git a/README.md b/README.md
index 64c4a11..21e60fd 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,15 @@
 [![Build Status](https://travis-ci.org/SeanJA/query-builder.svg?branch=master)](https://travis-ci.org/SeanJA/query-builder)
+[![Code coverage](https://codecov.io/gh/SeanJA/query-builder/branch/master/graph/badge.svg)](https://codecov.io/gh/SeanJA/query-builder)
 
 Requirements
 ==
 
-* PHP 5.2 +
+* PHP 5.5 +
 
 TODO
 ==
 
-List some todos...
+* PHP 5.2 branch
 
 Examples
 ==
diff --git a/source/DbInterface.php b/source/DbInterface.php
index b5c737e..fab4c9a 100644
--- a/source/DbInterface.php
+++ b/source/DbInterface.php
@@ -1,26 +1,33 @@
 <?php
+
 namespace SeanJA;
 
 interface DbInterface
 {
     /**
      * Escape a value
-     * @param $value
+     *
+     * @param string $value The value to be escaped
+     *
      * @return string
      */
     public function escape($value);
 
     /**
      * Quote a string
-     * @param $value
-     * @return mixed
+     *
+     * @param string $value The value to be quoted
+     *
+     * @return string
      */
     public function quote($value);
 
     /**
      * Quote a field
-     * @param $value
-     * @return mixed
+     *
+     * @param string $field The field to be quoted
+     *
+     * @return string
      */
-    public function fieldQuote($value);
+    public function fieldQuote($field);
 }
diff --git a/tests/source/Db.php b/tests/source/Db.php
index 13adcac..644b09b 100644
--- a/tests/source/Db.php
+++ b/tests/source/Db.php
@@ -4,21 +4,31 @@
 
 use SeanJA\DbInterface;
 
+/**
+ * Class Db
+ * @package Tests\SeanJA
+ */
 class Db implements DbInterface
 {
     /**
+     * Wrap string in this
+     *
      * @var string
      */
     const QUOTE = "'";
     /**
+     * Wrap fields in this
+     *
      * @var string
      */
     const FIELD_QUOTE = "`";
 
     /**
      * Escape a value
-     * @param $value
-     * @return mixed
+     *
+     * @param string $value The value to be escaped
+     *
+     * @return string
      */
     function escape($value)
     {
@@ -27,8 +37,10 @@ function escape($value)
 
     /**
      * Quote a string
-     * @param $value
-     * @return mixed
+     *
+     * @param string $value The value to be quoted
+     *
+     * @return string
      */
     public function quote($value)
     {
@@ -37,11 +49,13 @@ public function quote($value)
 
     /**
      * Quote a field
-     * @param $value
-     * @return mixed
+     *
+     * @param string $field The field to be quoted
+     *
+     * @return string
      */
-    public function fieldQuote($value)
+    public function fieldQuote($field)
     {
-        return static::FIELD_QUOTE . $value . static::FIELD_QUOTE;
+        return static::FIELD_QUOTE . $field . static::FIELD_QUOTE;
     }
 }