[FFmpeg-devel] [PATCH] ffprobe: make c_escape_str() documentation more terse

[Clément Bœsch]

On Sun, May 27, 2012 at 01:32:08AM +0200, Stefano Sabatini wrote:
> Avoid to specify implementation details, better to check the code for
> that.
> ---
>  ffprobe.c |    3 +--
>  1 files changed, 1 insertions(+), 2 deletions(-)
> 
> diff --git a/ffprobe.c b/ffprobe.c
> index 1f3497b..5fb4c47 100644
> --- a/ffprobe.c
> +++ b/ffprobe.c
> @@ -497,8 +497,7 @@ static const Writer default_writer = {
>  /* Compact output */
>  
>  /**
> - * Escape \n, \r, \f, \b, \\ and sep characters contained in s, and
> - * print the resulting string.
> + * Apply C-language-like string escaping.
>   */
>  static const char *c_escape_str(AVBPrint *dst, const char *src, const char sep, void *log_ctx)
>  {

What about simplifying the documentation description as well? (which is
also a bit verbose for nothing).

LGTM.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20120527/b0f8551a/attachment.asc>