[asterisk-bugs] [JIRA] (ASTERISK-25527) Quirky xmldoc description wrapping

[Walter Doekes (JIRA)]

     [ https://issues.asterisk.org/jira/browse/ASTERISK-25527?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Walter Doekes updated ASTERISK-25527:
-------------------------------------

    Description: 
Example, the output of {{core show application Dial}} says:
{noformat}
timeout
    Specifies the number of seconds we attempt to dial the specified
^-- 68 columns
    devices
    If not specified, this defaults to 136 years.
options
    A(x):
        x - The file to play to the called party
Play an announcement to the called party, where <x> is the prompt to be played
^-- 78 columns
{noformat}

Because of quirky behaviour, word wrapping feels random.

Expected output:
{noformat}
timeout
    Specifies the number of seconds we attempt to dial the specified devices
^-- 76 columns
    If not specified, this defaults to 136 years.
options
    A(x):
        x - The file to play to the called party
Play an announcement to the called party, where <x> is the prompt to be played
^-- 78 columns
{noformat}

The (soon to be) attached patch fixes it. And deletes lots of nasty code. It could certainly be improved still:
* not copying the data one char at a time
* taking escape sequences into account when counting back 30 characters

But for now this is better than it was.

  was:
Example, the output of {{core show application Dial}} says:
{noformat}
timeout
    Specifies the number of seconds we attempt to dial the specified
^-- 68 columns
    devices
    If not specified, this defaults to 136 years.
options
    A(x):
        x - The file to play to the called party
Play an announcement to the called party, where <x> is the prompt to be played
^-- 78 columns
{noformat}

Because of quirky behaviour, word wrapping feels random.

Expected output:
{noformat}
timeout
    Specifies the number of seconds we attempt to dial the specified devices
^-- 76 columns
    If not specified, this defaults to 136 years.
options
    A(x):
        x - The file to play to the called party
Play an announcement to the called party, where <x> is the prompt to be played
^-- 78 columns
{noformat}

The (soon to be) attached patch fixes it. And deletes lots of nasty code. It could certainly be improved still:
* not copying the data one char at a time
* taking escape sequences into account when counting back 30 characters
But for now this is better than it was.


> Quirky xmldoc description wrapping
> ----------------------------------
>
>                 Key: ASTERISK-25527
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-25527
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Documentation
>    Affects Versions: 11.20.0, 13.6.0
>            Reporter: Walter Doekes
>
> Example, the output of {{core show application Dial}} says:
> {noformat}
> timeout
>     Specifies the number of seconds we attempt to dial the specified
> ^-- 68 columns
>     devices
>     If not specified, this defaults to 136 years.
> options
>     A(x):
>         x - The file to play to the called party
> Play an announcement to the called party, where <x> is the prompt to be played
> ^-- 78 columns
> {noformat}
> Because of quirky behaviour, word wrapping feels random.
> Expected output:
> {noformat}
> timeout
>     Specifies the number of seconds we attempt to dial the specified devices
> ^-- 76 columns
>     If not specified, this defaults to 136 years.
> options
>     A(x):
>         x - The file to play to the called party
> Play an announcement to the called party, where <x> is the prompt to be played
> ^-- 78 columns
> {noformat}
> The (soon to be) attached patch fixes it. And deletes lots of nasty code. It could certainly be improved still:
> * not copying the data one char at a time
> * taking escape sequences into account when counting back 30 characters
> But for now this is better than it was.



--
This message was sent by Atlassian JIRA
(v6.2#6252)