Zend_CodeGenerator_Php_Docblock _docCommentize() produces unnecessary blank lines

[teejayhh]

Steps to reporduce;

1. create new class and save it

class Fb_Cms_Content_BlockObject extends Fb_Core_BaseObject
{
    /**
     * @var int
     */
    public $id = null;
    /**
     * @var string
     */
    public $componentId = null;
    /**
     * @var string
     */
    public $title = null;
    /**
     * @var int
     */
    public $status = null;
    /**
     * @var string
     */
    public $createdAt = null;
    /**
     * @var string
     */
    public $updatedAt = null;
}

1. now use the the gode generator to read in this class

$reflectionClass = new Zend_Reflection_Class($classNameToGenerate);
$phpClass = Zend_CodeGenerator_Php_Class::fromReflection($reflectionClass);

1. now generate the code

$phpClass->generate();

Result: Each property will gain an additional line which should not happen.

    /**
     * @var string
     * 
     */
    pub.....

you can resolve this issue with the following

    /**
     * _docCommentize()
     *
     * @param string $content
     * @return string
     */
    protected function _docCommentize($content)
    {
        $indent = $this->getIndentation();
        $output = $indent . '/**' . self::LINE_FEED;
        $content = wordwrap($content, 80, self::LINE_FEED);
        $lines = explode(self::LINE_FEED, $content);
        foreach ($lines as $line) {
            // change this
            $output .= $indent . ' *';
            if ($line) { 
                $output .= " $line";
            }
             $output .= self::LINE_FEED;
            // to this
            if ($line) { 
                $output .= $indent . ' *';
                $output .= " $line";
                $output .= self::LINE_FEED;
            }
        }
        $output .= $indent . ' */' . self::LINE_FEED;
        return $output;
    }

[froschdesign]

@teejayhh
Your fix removes all empty lines!

From this:

/**
 * File header here
 *
 * @author Ralph Schindler <ralph.schindler@zend.com>
 *
 */

to this:

/**
 * File header here
 * @author Ralph Schindler <ralph.schindler@zend.com>
 */

👎

[froschdesign]

Maybe:

protected function _docCommentize($content)
{
    $indent  = $this->getIndentation();
    $output  = $indent . '/**' . self::LINE_FEED;
    $content = wordwrap($content, 80, self::LINE_FEED);
    $lines   = explode(self::LINE_FEED, $content);

    foreach ($lines as $line) {
        $output .= $indent . ' *';
        if ($line) {
            $output .= " $line";
        }
        $output .= self::LINE_FEED;
    }

    // New!
    $output = rtrim($output, ' *' . self::LINE_FEED) . self::LINE_FEED;

    $output .= $indent . ' */' . self::LINE_FEED;
    return $output;
}

[froschdesign]

@weierophinney
Is this a BC break? What do you think?

At the moment it works as documented: Reference Guide

[weierophinney]

IF it were to retain blank lines between content in the docblocks, I'd be okay with it. Since it currently removes all blank lines in docblocks, we cannot keep it, as that removes the intent of short vs. long description, etc.