Strip hard line break in method summaries (#19)

Author: tkegan

docs/BasicClass.md

@@ -14,7 +14,7 @@ various PHPDoc tags are used.
 
 | Name | Description |
 |------|-------------|
-|[__construct](#basicclass__construct)|Constructs an object|
+|[__construct](#basicclass__construct)|Constructs an object of some specific type with certain unspoken defaults.|
 |[addValues](#basicclassaddvalues)|Adds two arguments|
 |[one](#basicclassone)|Returns one|
 
@@ -29,14 +29,15 @@ various PHPDoc tags are used.
 public __construct (array $options)
 ```
 
-Constructs an object 
+Constructs an object of some specific type with certain unspoken defaults. 
 
 
 
 **Parameters**
 
 * `(array) $options`
-: options  
+: the user's desired settings for the object being  
+created.  
 
 **Return Values**
 

example/BasicClass.php

@@ -17,9 +17,11 @@ class BasicClass
     public $config;
 
     /**
-     * Constructs an object
+     * Constructs an object of some specific type with certain unspoken
+     * defaults.
      *
-     * @param array $options options
+     * @param array $options  the user's desired settings for the object being
+     *      created.
      *
      * @return void
      */

src/Markdown/ClassInfo.php

@@ -29,7 +29,12 @@ abstract public function getFormatName();
     public function render()
     {
         $parser = new ClassParser($this->reflectionClass);
-        $methods = $parser->getMethodsDetails();
+        $methods = [];
+        foreach ($parser->getMethodsDetails() as $methodName => $methodDetails) {
+            $methodDetails->shortDescription = $this
+                ->removeHardLineBreaks($methodDetails->shortDescription);
+            $methods[$methodName] = $methodDetails;
+        }
         ksort($methods);
 
         $this->setData(
@@ -45,4 +50,13 @@ public function render()
         );
         return parent::render();
     }
+
+    /** Strip hard line wraps from string */
+    private function removeHardLineBreaks($text) {
+        return preg_replace(
+            ['(\n)', '( +)'],
+            [' ', ' '],
+            $text
+        );
+    }
 }