enum:annotate command breaks existing docblock descriptions

[tamiroh]

Problem

The enum:annotate command breaks existing docblock descriptions. For example, when the command is executed for an enum like the following,

/**
 * This is a test enum with multiple line comments.
 *
 * Test enum with multiple line comments. Test enum
 * with multiple line comments. Test enum with multiple line comments.
 *
 * Test enum with multiple line comments.
 *
 * @method static static A()
 * @method static static B()
 * @method static static C()
 * @extends Enum<int>
 */
final class EnumWithMultipleLineComments extends Enum
{
    const A = 1;
    const B = 2;
    const C = 3;
}

I expect docblock to remain the same, but as shown below, line breaks are lost from the description and the formatting is broken.

/**
 * This is a test enum with multiple line comments.
 *
 * Test enum with multiple line comments. Test enum with multiple line comments. Test enum with multiple line comments. Test enum with multiple line comments.
 *
 * @method static static A()
 * @method static static B()
 * @method static static C()
 * @extends Enum<int>
 */
final class EnumWithMultipleLineComments extends Enum
{
    const A = 1;
    const B = 2;
    const C = 3;
}

Survey

I have tried to determine the cause of the above behavior. As a result, I found that the laminas-code on which the docblock generation process depends is causing the problem. For more information, please refer to the following Issue I submitted.

laminas/laminas-code#177

I reported it as a bug, but it will probably never be fixed. This is because fixing it would be a breaking change. Therefore, to fix the enum:annotate problem, we would have to rewrite the logic above so that it does not depend on laminas-code.