{"id":2946,"url":"https://patchwork.libcamera.org/api/patches/2946/?format=json","web_url":"https://patchwork.libcamera.org/patch/2946/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20200229164254.23604-23-laurent.pinchart@ideasonboard.com>","date":"2020-02-29T16:42:45","name":"[libcamera-devel,22/31] libcamera: byte_stream_buffer: Fix documentation of read() and write()","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"3caaac17f6004bfc7715a73c10d176b6286afb9d","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/2946/mbox/","series":[{"id":696,"url":"https://patchwork.libcamera.org/api/series/696/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=696","date":"2020-02-29T16:42:23","name":"libcamera: Add support for array controls","version":1,"mbox":"https://patchwork.libcamera.org/series/696/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2946/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2946/checks/","tags":{},"headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 110636279A\n\tfor ;\n\tSat, 29 Feb 2020 17:43:30 +0100 (CET)","from pendragon.bb.dnainternet.fi (81-175-216-236.bb.dnainternet.fi\n\t[81.175.216.236])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 9510E33E;\n\tSat, 29 Feb 2020 17:43:29 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1582994609;\n\tbh=GNVlyIH05vqc1DFwT9iV1N/4mJpUnELHv9994EracBs=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=tu9O6CuNsg8KqkisRmWI6vx5ISXWWll2ZsWvLRbZmx0bEYOV2UuerkieOWd1MqxT5\n\t61USiJ+4GXrhXVZna+azg+0ozu1hEWWO0+zCEm+MyGTAs+7YjAaeS+LI33TD3yRYmR\n\tYxqfGnuKMBfwris0bIdDH8OmhxJP5pvKKf+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","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 22/31] libcamera: byte_stream_buffer: Fix\n\tdocumentation of read() and write()","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Sat, 29 Feb 2020 16:43:36 -0000"},"content":"From: Jacopo Mondi \n\nThe documentation of the read() and write() functions refer to\ninexistent 'size' and 'data' parameters in their brief. Fix them.\n\nSigned-off-by: Jacopo Mondi \nSigned-off-by: Laurent Pinchart \n---\n src/libcamera/byte_stream_buffer.cpp | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)","diff":"diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp\nindex 23d624dd0a06..cd1d8a36d464 100644\n--- a/src/libcamera/byte_stream_buffer.cpp\n+++ b/src/libcamera/byte_stream_buffer.cpp\n@@ -225,7 +225,7 @@ int ByteStreamBuffer::skip(size_t size)\n \n /**\n * \\fn template int ByteStreamBuffer::read(T *t)\n- * \\brief Read \\a size \\a data from the managed memory buffer\n+ * \\brief Read data from the managed memory buffer into \\a t\n * \\param[out] t Pointer to the memory containing the read data\n * \\return 0 on success, a negative error code otherwise\n * \\retval -EACCES attempting to read from a write buffer\n@@ -234,7 +234,7 @@ int ByteStreamBuffer::skip(size_t size)\n \n /**\n * \\fn template int ByteStreamBuffer::write(const T *t)\n- * \\brief Write \\a data of \\a size to the managed memory buffer\n+ * \\brief Write \\a t to the managed memory buffer\n * \\param[in] t The data to write to memory\n * \\return 0 on success, a negative error code otherwise\n * \\retval -EACCES attempting to write to a read buffer\n","prefixes":["libcamera-devel","22/31"]}