Summary: | ASTERISK-05918: incorrect documentation for ast_trim_blanks() | ||
Reporter: | Luigi Rizzo (rizzo) | Labels: | |
Date Opened: | 2005-12-28 11:58:16.000-0600 | Date Closed: | 2006-01-05 16:55:03.000-0600 |
Priority: | Trivial | Regression? | No |
Status: | Closed/Complete | Components: | Core/General |
Versions: | Frequency of Occurrence | ||
Related Issues: | |||
Environment: | Attachments: | ||
Description: | the description of ast_trim_blanks() says it returns a pointer to the terminating NUL (misspelled as NULL), but in fact it returns a pointer to the original string. The return argument is never used at the moment, so we have 3 possible fixes: 1. work as documented; it is a bit tricky, and probably pointless because i am not sure anyone is really interested to this info; 2. correct the documentation to match the code. Note however that returning the original argument as the code does now is not really useful - the caller has it already availble; 3. update documentation and code and make the function return void. I think my vote would go for #3. | ||
Comments: | By: Tilghman Lesher (tilghman) 2006-01-05 16:54:49.000-0600 Committed to 1.2, merged to trunk |