[Asterisk-code-review] iostreams: Add some documentation for the ast iostream * fun... (asterisk[15])

[Richard Mudgett]

Richard Mudgett has posted comments on this change. ( https://gerrit.asterisk.org/8888 )

Change subject: iostreams: Add some documentation for the ast_iostream_* functions
......................................................................


Patch Set 1: Code-Review-1

(6 comments)

-1 because of the parameter naming inconsistencies.

https://gerrit.asterisk.org/#/c/8888/1/include/asterisk/iostream.h
File include/asterisk/iostream.h:

https://gerrit.asterisk.org/#/c/8888/1/include/asterisk/iostream.h@a65
PS1, Line 65: 
Should keep this as it describes what the function returns.


https://gerrit.asterisk.org/#/c/8888/1/include/asterisk/iostream.h@a85
PS1, Line 85: 
Should keep this as it describes what the function returns.


https://gerrit.asterisk.org/#/c/8888/1/include/asterisk/iostream.h@a99
PS1, Line 99: 
Should keep this as it describes what the function returns.


https://gerrit.asterisk.org/#/c/8888/1/include/asterisk/iostream.h@154
PS1, Line 154: ssize_t ast_iostream_read(struct ast_iostream *stream, void *buffer, size_t count);
Changing the second parameter name to buffer makes parameter inconsistent with the doxygen and the actual function definition.

The third parameter of the function definition is size not count.


https://gerrit.asterisk.org/#/c/8888/1/include/asterisk/iostream.h@170
PS1, Line 170: ssize_t ast_iostream_gets(struct ast_iostream *stream, char *buffer, size_t size);
Changing the second parameter name to buffer makes parameter inconsistent with the doxygen and the actual function definition.

The third parameter of the function definition is count not size.


https://gerrit.asterisk.org/#/c/8888/1/include/asterisk/iostream.h@209
PS1, Line 209: ssize_t __attribute__((format(printf, 2, 3))) ast_iostream_printf(
             : 	struct ast_iostream *stream, const char *format, ...);
The second parameter of the function definition is fmt not format.



-- 
To view, visit https://gerrit.asterisk.org/8888
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 15
Gerrit-MessageType: comment
Gerrit-Change-Id: Id71b87637f0a484eb5a1cd26c3d1c7c15c7dcf26
Gerrit-Change-Number: 8888
Gerrit-PatchSet: 1
Gerrit-Owner: Sean Bright <sean.bright at gmail.com>
Gerrit-Reviewer: Jenkins2
Gerrit-Reviewer: Richard Mudgett <rmudgett at digium.com>
Gerrit-Comment-Date: Wed, 02 May 2018 21:02:46 +0000
Gerrit-HasComments: Yes
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20180502/22ba0c83/attachment-0001.html>