{"id":1061,"url":"https://patchwork.libcamera.org/api/patches/1061/?format=json","web_url":"https://patchwork.libcamera.org/patch/1061/","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":"<20190418151824.30127-1-jacopo@jmondi.org>","date":"2019-04-18T15:18:24","name":"[libcamera-devel] libcamera: stream: Document protected members","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"a21e7d5a8151bf16cccff6372119b48cc4bcc88f","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/1061/mbox/","series":[{"id":257,"url":"https://patchwork.libcamera.org/api/series/257/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=257","date":"2019-04-18T15:18:24","name":"[libcamera-devel] libcamera: stream: Document protected members","version":1,"mbox":"https://patchwork.libcamera.org/series/257/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/1061/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/1061/checks/","tags":{},"headers":{"Return-Path":"","Received":["from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net\n\t[217.70.183.201])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4DFFF60DBE\n\tfor ;\n\tThu, 18 Apr 2019 17:17:37 +0200 (CEST)","from uno.lan (2-224-242-101.ip172.fastwebnet.it [2.224.242.101])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay8-d.mail.gandi.net (Postfix) with ESMTPSA id D2A321BF213;\n\tThu, 18 Apr 2019 15:17:36 +0000 (UTC)"],"X-Originating-IP":"2.224.242.101","From":"Jacopo Mondi ","To":"libcamera-devel@lists.libcamera.org","Date":"Thu, 18 Apr 2019 17:18:24 +0200","Message-Id":"<20190418151824.30127-1-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.21.0","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH] libcamera: stream: Document protected\n\tmembers","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Thu, 18 Apr 2019 15:17:37 -0000"},"content":"Since commit:\n4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\nthe private members of the Stream class have been turned into protected,\nto allows sub-class to access them.\n\nAs Doxygen generates documentation for protected members (but not\nprivate ones), add documentation to the stream class for the\n'bufferMap_' and 'configuration_' members.\n\nFixes: 4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\nSigned-off-by: Jacopo Mondi \n---\n src/libcamera/stream.cpp | 17 +++++++++++++++++\n 1 file changed, 17 insertions(+)","diff":"diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp\nindex 85cd5256ee2f..5839b983f45f 100644\n--- a/src/libcamera/stream.cpp\n+++ b/src/libcamera/stream.cpp\n@@ -194,4 +194,21 @@ Stream::Stream()\n * \\return The active configuration of the stream\n */\n \n+/**\n+ * \\var Stream::bufferPool_\n+ * \\brief The pool of buffers associated with the stream\n+ *\n+ * The stream buffer pool is populated by the Camera class after a succesfull\n+ * stream configuration.\n+ */\n+\n+/**\n+ * \\var Stream::configuration_\n+ * \\brief The configuration associated with the stream\n+ *\n+ * The stream configuration is accessible only to Stream sub-classes and to\n+ * the Camera class, that associates the Stream with the configuration returned\n+ * by a succesfull PipelineHandler::configureStreams() call.\n+ */\n+\n } /* namespace libcamera */\n","prefixes":["libcamera-devel"]}