Summary:	ASTERISK-25527: Quirky xmldoc description wrapping
Reporter:	Walter Doekes (wdoekes)	Labels:
Date Opened:	2015-11-06 07:35:12.000-0600	Date Closed:	2015-11-11 08:08:46.000-0600
Priority:	Major	Regression?
Status:	Closed/Complete	Components:	Documentation
Versions:	11.20.0 13.6.0	Frequency of Occurrence
Related Issues:
Environment:		Attachments:	( 0) ASTERISK-25527-11.patch ( 1) new-nocolor.txt ( 2) old-nocolor.txt
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 attached patch {{ASTERISK-25527-11.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. Compare {{new-nocolor.txt}} with {{old-nocolor.txt}} to see the changed output. (Also includes a few typo fixes. Those will be fixed elsewhere.)
Comments:	By: Asterisk Team (asteriskteam) 2015-11-06 07:35:14.291-0600 Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution. A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report. Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process]. By: Rusty Newton (rnewton) 2015-11-06 07:48:07.355-0600 Thanks Walter!