From patchwork Sat Feb 29 16:42:45 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 2946 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 110636279A for ; Sat, 29 Feb 2020 17:43:30 +0100 (CET) Received: from pendragon.bb.dnainternet.fi (81-175-216-236.bb.dnainternet.fi [81.175.216.236]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 9510E33E; Sat, 29 Feb 2020 17:43:29 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1582994609; bh=GNVlyIH05vqc1DFwT9iV1N/4mJpUnELHv9994EracBs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=tu9O6CuNsg8KqkisRmWI6vx5ISXWWll2ZsWvLRbZmx0bEYOV2UuerkieOWd1MqxT5 61USiJ+4GXrhXVZna+azg+0ozu1hEWWO0+zCEm+MyGTAs+7YjAaeS+LI33TD3yRYmR YxqfGnuKMBfwris0bIdDH8OmhxJP5pvKKf+9G3uw= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Sat, 29 Feb 2020 18:42:45 +0200 Message-Id: <20200229164254.23604-23-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200229164254.23604-1-laurent.pinchart@ideasonboard.com> References: <20200229164254.23604-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 22/31] libcamera: byte_stream_buffer: Fix documentation of read() and write() X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 29 Feb 2020 16:43:36 -0000 From: Jacopo Mondi The documentation of the read() and write() functions refer to inexistent 'size' and 'data' parameters in their brief. Fix them. Signed-off-by: Jacopo Mondi Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham --- src/libcamera/byte_stream_buffer.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp index 23d624dd0a06..cd1d8a36d464 100644 --- a/src/libcamera/byte_stream_buffer.cpp +++ b/src/libcamera/byte_stream_buffer.cpp @@ -225,7 +225,7 @@ int ByteStreamBuffer::skip(size_t size) /** * \fn template int ByteStreamBuffer::read(T *t) - * \brief Read \a size \a data from the managed memory buffer + * \brief Read data from the managed memory buffer into \a t * \param[out] t Pointer to the memory containing the read data * \return 0 on success, a negative error code otherwise * \retval -EACCES attempting to read from a write buffer @@ -234,7 +234,7 @@ int ByteStreamBuffer::skip(size_t size) /** * \fn template int ByteStreamBuffer::write(const T *t) - * \brief Write \a data of \a size to the managed memory buffer + * \brief Write \a t to the managed memory buffer * \param[in] t The data to write to memory * \return 0 on success, a negative error code otherwise * \retval -EACCES attempting to write to a read buffer