{"id":12009,"url":"https://patchwork.libcamera.org/api/1.1/patches/12009/?format=json","web_url":"https://patchwork.libcamera.org/patch/12009/","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":"<20210420093859.14280-3-jacopo@jmondi.org>","date":"2021-04-20T09:38:59","name":"[libcamera-devel,v2,2/2] libcamera: class: Drop 'klass' argument from documentation","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"fedc30a5aa28758185f741bf9eef2fab94fcf9f3","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/1.1/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":{"id":15,"url":"https://patchwork.libcamera.org/api/1.1/users/15/?format=json","username":"jmondi","first_name":"Jacopo","last_name":"Mondi","email":"jacopo@jmondi.org"},"mbox":"https://patchwork.libcamera.org/patch/12009/mbox/","series":[{"id":1951,"url":"https://patchwork.libcamera.org/api/1.1/series/1951/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1951","date":"2021-04-20T09:38:57","name":"Minor fixes to src/libcamera/class.cpp","version":2,"mbox":"https://patchwork.libcamera.org/series/1951/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/12009/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/12009/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 4B12DBD816\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Apr 2021 09:38:27 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B10CE68848;\n\tTue, 20 Apr 2021 11:38:24 +0200 (CEST)","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 93A1C68835\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Apr 2021 11:38:23 +0200 (CEST)","from uno.lan (93-34-118-233.ip49.fastwebnet.it [93.34.118.233])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay8-d.mail.gandi.net (Postfix) with ESMTPSA id 38B471BF218;\n\tTue, 20 Apr 2021 09:38:23 +0000 (UTC)"],"X-Originating-IP":"93.34.118.233","From":"Jacopo Mondi <jacopo@jmondi.org>","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 20 Apr 2021 11:38:59 +0200","Message-Id":"<20210420093859.14280-3-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.31.1","In-Reply-To":"<20210420093859.14280-1-jacopo@jmondi.org>","References":"<20210420093859.14280-1-jacopo@jmondi.org>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH v2 2/2] libcamera: class: Drop 'klass'\n\targument from documentation","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"The LIBCAMERA_D_PTR() and LIBCAMERA_O_PTR() macros do not require an\nargument, but the version of the macro consumed by Doxygen does.\n\nFix this by removing the klass parameter from both macros in their\ndocumentation version.\n\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\n---\n include/libcamera/class.h | 4 ++--\n src/libcamera/class.cpp   | 6 ++----\n 2 files changed, 4 insertions(+), 6 deletions(-)","diff":"diff --git a/include/libcamera/class.h b/include/libcamera/class.h\nindex 466114ecfaf4..f384a4889588 100644\n--- a/include/libcamera/class.h\n+++ b/include/libcamera/class.h\n@@ -48,8 +48,8 @@ public:\t\t\t\t\t\t\t\t\t\\\n #else\n #define LIBCAMERA_DECLARE_PRIVATE()\n #define LIBCAMERA_DECLARE_PUBLIC(klass)\n-#define LIBCAMERA_D_PTR(klass)\n-#define LIBCAMERA_O_PTR(klass)\n+#define LIBCAMERA_D_PTR()\n+#define LIBCAMERA_O_PTR()\n #endif\n \n class Extensible\ndiff --git a/src/libcamera/class.cpp b/src/libcamera/class.cpp\nindex 171f7c0a927b..28c35633d7db 100644\n--- a/src/libcamera/class.cpp\n+++ b/src/libcamera/class.cpp\n@@ -95,9 +95,8 @@ namespace libcamera {\n  */\n \n /**\n- * \\def LIBCAMERA_D_PTR(klass)\n+ * \\def LIBCAMERA_D_PTR()\n  * \\brief Retrieve the private data pointer\n- * \\param[in] klass The public class name\n  *\n  * This macro can be used in any member function of a class that inherits,\n  * directly or indirectly, from the Extensible class, to create a local\n@@ -105,9 +104,8 @@ namespace libcamera {\n  */\n \n /**\n- * \\def LIBCAMERA_O_PTR(klass)\n+ * \\def LIBCAMERA_O_PTR()\n  * \\brief Retrieve the public instance corresponding to the private data\n- * \\param[in] klass The public class name\n  *\n  * This macro is the counterpart of LIBCAMERA_D_PTR() for private data classes.\n  * It can be used in any member function of the private data class to create a\n","prefixes":["libcamera-devel","v2","2/2"]}