[{"id":1462,"web_url":"https://patchwork.libcamera.org/comment/1462/","msgid":"<20190418153206.GW4806@pendragon.ideasonboard.com>","date":"2019-04-18T15:32:06","subject":"Re: [libcamera-devel] [PATCH] libcamera: stream: Document protected\n\tmembers","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Jacopo,\n\nThank you for the patch.\n\nOn Thu, Apr 18, 2019 at 05:18:24PM +0200, Jacopo Mondi wrote:\n> Since commit:\n> 4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\n\nNo need for a blank line,\n\nSince commit 4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\n\n> the private members of the Stream class have been turned into protected,\n> to allows sub-class to access them.\n\ns/allows sub-class/allow subclasses/\n\n> As Doxygen generates documentation for protected members (but not\n> private ones), add documentation to the stream class for the\n\ns/ones/members/\n\n> 'bufferMap_' and 'configuration_' members.\n> \n> Fixes: 4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\n> Signed-off-by: Jacopo Mondi \n> ---\n> src/libcamera/stream.cpp | 17 +++++++++++++++++\n> 1 file changed, 17 insertions(+)\n> \n> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp\n> index 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\nThis is implied by its protected status, isn't it ?\n\n> + * the Camera class, that associates the Stream with the configuration returned\n> + * by a succesfull PipelineHandler::configureStreams() call.\n\nHow about documenting when the configuration is set ?\n\n * \\brief The stream configuration\n *\n * The configuration for the stream is set by any successful call to\n * Camera::configureStreams() to includes the stream, and remains valid until\n * the next call to Camera::configureStreams() regardless of if it includes the\n * stream.\n\n> + */\n> +\n> } /* namespace libcamera */","headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B4A0C60DBE\n\tfor ;\n\tThu, 18 Apr 2019 17:32:15 +0200 (CEST)","from pendragon.ideasonboard.com (81-175-216-236.bb.dnainternet.fi\n\t[81.175.216.236])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id F0F3E333;\n\tThu, 18 Apr 2019 17:32:14 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1555601535;\n\tbh=h8TnTk++bgQjj74Vxxw1446V2cEqRSgvcGa53nAq7p0=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=UthLKuTw/iPh6nPItvVaT8QZw7l+lres/RdwWXQr81t8aI1HXcJmZ0ykm5c+fneUc\n\tCyyayMkx6h4KF+TGsWvMhGf1ktUtz6gvh79E17kaWH53VhW+sHehZ1cIvz2rluCQPm\n\tkvLeF5bXJ+To2gic/1RL46vkbFUc10+kL1137Gr0=","Date":"Thu, 18 Apr 2019 18:32:06 +0300","From":"Laurent Pinchart ","To":"Jacopo Mondi ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20190418153206.GW4806@pendragon.ideasonboard.com>","References":"<20190418151824.30127-1-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20190418151824.30127-1-jacopo@jmondi.org>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [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:32:15 -0000"}},{"id":1475,"web_url":"https://patchwork.libcamera.org/comment/1475/","msgid":"<20190419090124.s7n7w7gh6zk67vbl@uno.localdomain>","date":"2019-04-19T09:01:24","subject":"Re: [libcamera-devel] [PATCH] libcamera: stream: Document protected\n\tmembers","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent,\n\nOn Thu, Apr 18, 2019 at 06:32:06PM +0300, Laurent Pinchart wrote:\n> Hi Jacopo,\n>\n> Thank you for the patch.\n>\n> On Thu, Apr 18, 2019 at 05:18:24PM +0200, Jacopo Mondi wrote:\n> > Since commit:\n> > 4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\n>\n> No need for a blank line,\n>\n> Since commit 4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\n>\n> > the private members of the Stream class have been turned into protected,\n> > to allows sub-class to access them.\n>\n> s/allows sub-class/allow subclasses/\n>\n> > As Doxygen generates documentation for protected members (but not\n> > private ones), add documentation to the stream class for the\n>\n> s/ones/members/\n>\n> > 'bufferMap_' and 'configuration_' members.\n> >\n> > Fixes: 4e1dc9004fca (\"libcamera: stream: Make Stream inheritable\")\n> > Signed-off-by: Jacopo Mondi \n> > ---\n> > src/libcamera/stream.cpp | 17 +++++++++++++++++\n> > 1 file changed, 17 insertions(+)\n> >\n> > diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp\n> > index 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>\n> This is implied by its protected status, isn't it ?\n>\n> > + * the Camera class, that associates the Stream with the configuration returned\n> > + * by a succesfull PipelineHandler::configureStreams() call.\n>\n> How about documenting when the configuration is set ?\n>\n> * \\brief The stream configuration\n> *\n> * The configuration for the stream is set by any successful call to\n> * Camera::configureStreams() to includes the stream, and remains valid until\n> * the next call to Camera::configureStreams() regardless of if it includes the\n> * stream.\n>\n\nTaken in with s/to includes/that includes/\n\nThanks\n j\n\n> > + */\n> > +\n> > } /* namespace libcamera */\n>\n> --\n> Regards,\n>\n> Laurent Pinchart","headers":{"Return-Path":"","Received":["from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net\n\t[217.70.183.195])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 5BB6860DB4\n\tfor ;\n\tFri, 19 Apr 2019 11:00:31 +0200 (CEST)","from uno.localdomain (2-224-242-101.ip172.fastwebnet.it\n\t[2.224.242.101]) (Authenticated sender: jacopo@jmondi.org)\n\tby relay3-d.mail.gandi.net (Postfix) with ESMTPSA id C707D6000A;\n\tFri, 19 Apr 2019 09:00:30 +0000 (UTC)"],"X-Originating-IP":"2.224.242.101","Date":"Fri, 19 Apr 2019 11:01:24 +0200","From":"Jacopo Mondi ","To":"Laurent Pinchart ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20190419090124.s7n7w7gh6zk67vbl@uno.localdomain>","References":"<20190418151824.30127-1-jacopo@jmondi.org>\n\t<20190418153206.GW4806@pendragon.ideasonboard.com>","MIME-Version":"1.0","Content-Type":"multipart/signed; micalg=pgp-sha256;\n\tprotocol=\"application/pgp-signature\"; boundary=\"g3sh7g7agyjlxybb\"","Content-Disposition":"inline","In-Reply-To":"<20190418153206.GW4806@pendragon.ideasonboard.com>","User-Agent":"NeoMutt/20180716","Subject":"Re: [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":"Fri, 19 Apr 2019 09:00:31 -0000"}}]