From ca138ffebb5ccab9b3fedc1234a9c5ba33bb4bb0 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Tue, 9 Oct 2012 23:05:44 +0200 Subject: [PATCH] btr_next_buffer_omit(): Add comment on passing NULL pointer. It has always been OK to pass a NULL buffer pointer to this function, but this was not documented yet. --- buffer_tree.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/buffer_tree.c b/buffer_tree.c index 5756898b..30f875fa 100644 --- a/buffer_tree.c +++ b/buffer_tree.c @@ -602,7 +602,7 @@ static size_t btr_get_buffer_by_reference(struct btr_buffer_reference *br, char * * \param btrn The node whose input queue is to be queried. * \param omit Number of bytes to be omitted. - * \param bufp Result pointer. + * \param bufp Result pointer. It is OK to pass \p NULL here. * * If a buffer tree node needs more input data but can not consume the data it * already has (because it might be needed again later) this function can be -- 2.39.2