The issue here is such "magic" annotations are single-line by nature:
/**
> * @method static Foo bar() This method has a long description that
> extends through several lines.
> * This line should also be included in the documentation of Foo:bar()
> */
> class Foo
> {
> }
It is by no means evident that the line that follows the annotation will be
included in the documentation, although I believe it should. By making it
explicit in the standard, leaves no room for misinterpretation on whether
it is the expected result or not.
_marcos
Em qui, 15 de nov de 2018 às 12:44, Chuck Burgess <[email protected]>
escreveu:
> I don't know that I remember ever encountering any Description piece,
> whether for DocBlock overall or individual Tags, where multiline was
> prohibited.
>
> The only arguments I've ever seen regarding multiline Tag Descriptions was
> about indenting the subsequent lines.
>
> Let me know if you see any places in the PSR-5 / PSR-19 drafts that seem
> to prohibit them.
> CRB
>
> On Thu, Nov 15, 2018, 08:35 Marcos Passos <[email protected]
> wrote:
>
>> Hello folks,
>>
>> I would like to propose standardizing support to multiline descriptions
>> in magic @property and @method annotation. Not allowing it has the impact
>> of having long lines with bad readability and no paragraph support.
>>
>> What is your opinion on that?
>>
>> - Marcos
>>
>> --
>> You received this message because you are subscribed to the Google Groups
>> "PHP Framework Interoperability Group" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to [email protected].
>> To post to this group, send email to [email protected].
>> To view this discussion on the web visit
>> https://groups.google.com/d/msgid/php-fig/f4cbc59b-0f6b-4a56-a018-9be377ca1ea7%40googlegroups.com
>> <https://groups.google.com/d/msgid/php-fig/f4cbc59b-0f6b-4a56-a018-9be377ca1ea7%40googlegroups.com?utm_medium=email&utm_source=footer>
>> .
>> For more options, visit https://groups.google.com/d/optout.
>>
> --
> You received this message because you are subscribed to the Google Groups
> "PHP Framework Interoperability Group" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To post to this group, send email to [email protected].
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/php-fig/CANsgjntihWVr2cCEsfMADaNgdMmS6_QhCGTFLY9iPKuVgXHh1A%40mail.gmail.com
> <https://groups.google.com/d/msgid/php-fig/CANsgjntihWVr2cCEsfMADaNgdMmS6_QhCGTFLY9iPKuVgXHh1A%40mail.gmail.com?utm_medium=email&utm_source=footer>
> .
> For more options, visit https://groups.google.com/d/optout.
>
--
You received this message because you are subscribed to the Google Groups "PHP
Framework Interoperability Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/php-fig/CANA3DetLvCgsa0nEuqqO3jK-50bFXKVwohu4DwoN95s29OCZ5A%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
