{"id":13087,"url":"https://patchwork.libcamera.org/api/1.1/patches/13087/?format=json","web_url":"https://patchwork.libcamera.org/patch/13087/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20210723040036.32346-2-laurent.pinchart@ideasonboard.com>","date":"2021-07-23T04:00:20","name":"[libcamera-devel,RFC,01/17] libcamera: base: class: Document Extensible::_d() functions","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"77b7fabddd7dcd8105848784302193781192a637","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/13087/mbox/","series":[{"id":2270,"url":"https://patchwork.libcamera.org/api/1.1/series/2270/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2270","date":"2021-07-23T04:00:19","name":"libcamera: Replace CameraData with Camera::Private","version":1,"mbox":"https://patchwork.libcamera.org/series/2270/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/13087/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/13087/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3DADFC322B\n\tfor ;\n\tFri, 23 Jul 2021 04:00:48 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id BAC29687B4;\n\tFri, 23 Jul 2021 06:00:45 +0200 (CEST)","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 700CE6877A\n\tfor ;\n\tFri, 23 Jul 2021 06:00:43 +0200 (CEST)","from pendragon.lan (62-78-145-57.bb.dnainternet.fi [62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id E5BC03F2\n\tfor ;\n\tFri, 23 Jul 2021 06:00:42 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"pvqHwvME\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1627012843;\n\tbh=UG9ct1KXXPEd4vIWbovc+WYBYilIrGIsVtS/6JPe8Hk=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=pvqHwvMEn2B4ll5y0rXz9MdRJ9nq62zEYKRTpmh4JP0eN0KUJ3tV68rpFyeb8UJP5\n\tWSqbPQMmlZIDsRgMrY/QmC4wv1Tn6hp7GipB9GZosRO3gLB4fhz0NsLJ4MVF8a4L3Z\n\taezC0qjPBdE361C3j0BIXMdzYG1kNDGa9nAjJaj8=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Date":"Fri, 23 Jul 2021 07:00:20 +0300","Message-Id":"<20210723040036.32346-2-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.31.1","In-Reply-To":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [RFC PATCH 01/17] libcamera: base: class:\n\tDocument Extensible::_d() functions","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The Extensible::_d() functions are meant to be called by users of the\nclass. Document them.\n\nSigned-off-by: Laurent Pinchart \n---\n include/libcamera/base/class.h | 2 --\n src/libcamera/base/class.cpp | 17 +++++++++++++++++\n 2 files changed, 17 insertions(+), 2 deletions(-)","diff":"diff --git a/include/libcamera/base/class.h b/include/libcamera/base/class.h\nindex c2e1d3534ed1..9c7f0f2e6e27 100644\n--- a/include/libcamera/base/class.h\n+++ b/include/libcamera/base/class.h\n@@ -88,7 +88,6 @@ public:\n \tExtensible(Private *d);\n \n protected:\n-#ifndef __DOXYGEN__\n \ttemplate\n \tconst T *_d() const\n \t{\n@@ -100,7 +99,6 @@ protected:\n \t{\n \t\treturn static_cast(d_.get());\n \t}\n-#endif\n \n private:\n \tconst std::unique_ptr d_;\ndiff --git a/src/libcamera/base/class.cpp b/src/libcamera/base/class.cpp\nindex 26b4967726d6..d0899671ca11 100644\n--- a/src/libcamera/base/class.cpp\n+++ b/src/libcamera/base/class.cpp\n@@ -150,6 +150,23 @@ Extensible::Extensible(Extensible::Private *d)\n {\n }\n \n+/**\n+ * \\fn Extensible::_d() const\n+ * \\brief Retrieve the private data instance\n+ *\n+ * This template function isn't meant to be called directly. Instead, classes\n+ * derived from Extensible get, through the LIBCAMERA_DECLARE_PRIVATE() macro,\n+ * overriden _d() functions that return the correct pointer type to the\n+ * corresponding derived Private class.\n+ *\n+ * \\return A pointer to the private data instance\n+ */\n+\n+/**\n+ * \\fn Extensible::_d()\n+ * \\copydoc Extensible::_d() const\n+ */\n+\n /**\n * \\var Extensible::d_\n * \\brief Pointer to the private data instance\n","prefixes":["libcamera-devel","RFC","01/17"]}