[{"id":16385,"web_url":"https://patchwork.libcamera.org/comment/16385/","msgid":"<YH67TPZ8I0fKzs+y@oden.dyn.berto.se>","date":"2021-04-20T11:30:20","subject":"Re: [libcamera-devel] [PATCH v2 2/2] libcamera: class: Drop 'klass'\n\targument from documentation","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Jacopo,\n\nThanks for your patch.\n\nOn 2021-04-20 11:38:59 +0200, Jacopo Mondi wrote:\n> The LIBCAMERA_D_PTR() and LIBCAMERA_O_PTR() macros do not require an\n> argument, but the version of the macro consumed by Doxygen does.\n> \n> Fix this by removing the klass parameter from both macros in their\n> documentation version.\n> \n> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>\n\nReviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n\n> ---\n>  include/libcamera/class.h | 4 ++--\n>  src/libcamera/class.cpp   | 6 ++----\n>  2 files changed, 4 insertions(+), 6 deletions(-)\n> \n> diff --git a/include/libcamera/class.h b/include/libcamera/class.h\n> index 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\n> diff --git a/src/libcamera/class.cpp b/src/libcamera/class.cpp\n> index 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> -- \n> 2.31.1\n> \n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","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 3DE77BDB15\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Apr 2021 11:30:23 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0137468840;\n\tTue, 20 Apr 2021 13:30:23 +0200 (CEST)","from mail-lf1-x129.google.com (mail-lf1-x129.google.com\n\t[IPv6:2a00:1450:4864:20::129])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 8A20660516\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Apr 2021 13:30:21 +0200 (CEST)","by mail-lf1-x129.google.com with SMTP id g8so60975089lfv.12\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Apr 2021 04:30:21 -0700 (PDT)","from localhost (h-209-203.A463.priv.bahnhof.se. [155.4.209.203])\n\tby smtp.gmail.com with ESMTPSA id\n\ti8sm2130571lfc.115.2021.04.20.04.30.20\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tTue, 20 Apr 2021 04:30:20 -0700 (PDT)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (2048-bit key;\n\tunprotected) header.d=ragnatech-se.20150623.gappssmtp.com\n\theader.i=@ragnatech-se.20150623.gappssmtp.com\n\theader.b=\"0Azg/AwR\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=ragnatech-se.20150623.gappssmtp.com; s=20150623;\n\th=date:from:to:cc:subject:message-id:references:mime-version\n\t:content-disposition:content-transfer-encoding:in-reply-to;\n\tbh=lJH0wFq3RPqKwlqhiPZqJsxsAyxnzzi8crZ/0pX9rjc=;\n\tb=0Azg/AwRPwebck/hln/SHmBd8d7Fnfai5ouSfJwfbVpcj2x4vPdjdBWNBeFIFTcslp\n\tGO68gY1oydy7C14cVEbCmhE2EPIEXgSNJwELDIg9IKIPKcThuEJm+IGriEz0euYnfRGe\n\tQ/XgV6O+F0wsQ+YAmfnz3kkY2+9vEoiIPMQbQnkaLO20DXeovsgLMGvHJOrGFV0nXNgP\n\tZa6SeP4b94FcJl7YvWl2/jsoqLTa2PSgNm44hOd5ZO0r6FIjpZoCo1gTSy7eXMxKYM8H\n\tQmMlKANY5Wyvpdu5Zdeb3pwnzcZ1syqs97rgCBleAya1922QbNPOhNKxzhpSwzL40HTh\n\tMQIg==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:date:from:to:cc:subject:message-id:references\n\t:mime-version:content-disposition:content-transfer-encoding\n\t:in-reply-to;\n\tbh=lJH0wFq3RPqKwlqhiPZqJsxsAyxnzzi8crZ/0pX9rjc=;\n\tb=tN1qJy3cEVADesuTGTAxPTLokEImPzZ23MmKmC97BUdmUloj3rGmD4wuZkiOsJaa9C\n\tc7kqs6NCbvMsOhWtS35c2Kb4TIyHOVod/mUEMC12DJSr+xN0SzaDImXkkZtmw4XsWAQD\n\tis5OX4q83t368cgnxdAWp+HqbagZ9NcujmUS+Hp0i01Tr9c/FAszIMVlwJEnf8GqoyXY\n\tupWvQpU1jBbQaCeLSYCWwBKYcwYTTDQm10EiIJV9OkCdDOI9Rlash3KUkbgU7tvu7iIj\n\t0uLxC3JkgvHKwbtzKJiwANMfQegLguF46pKBJViG0A6MKvg0FaXAoq9CVoAsDw+rf5nr\n\tEg2A==","X-Gm-Message-State":"AOAM533E44TpP57FCtBhN6jnIt2TdQ02L4vKtcT9P7AIFkHg+kppJahJ\n\tvvCwTWbR8hy7d0R+t1BbacI+1IOQnp+qOd2u","X-Google-Smtp-Source":"ABdhPJwjjeTnGqsNPS7bwVCrV24HSEw8AKy7dO9IEUs+4qrHVie8dBX6lXcARMGSK6tvCLA17WwaOA==","X-Received":"by 2002:a05:6512:22d3:: with SMTP id\n\tg19mr12878760lfu.291.1618918221073; \n\tTue, 20 Apr 2021 04:30:21 -0700 (PDT)","Date":"Tue, 20 Apr 2021 13:30:20 +0200","From":"Niklas =?iso-8859-1?q?S=F6derlund?= <niklas.soderlund@ragnatech.se>","To":"Jacopo Mondi <jacopo@jmondi.org>","Message-ID":"<YH67TPZ8I0fKzs+y@oden.dyn.berto.se>","References":"<20210420093859.14280-1-jacopo@jmondi.org>\n\t<20210420093859.14280-3-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20210420093859.14280-3-jacopo@jmondi.org>","Subject":"Re: [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>","Cc":"libcamera-devel@lists.libcamera.org","Content-Type":"text/plain; charset=\"iso-8859-1\"","Content-Transfer-Encoding":"quoted-printable","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}},{"id":16420,"web_url":"https://patchwork.libcamera.org/comment/16420/","msgid":"<YH9bR/vCVT8o8uLW@pendragon.ideasonboard.com>","date":"2021-04-20T22:52:55","subject":"Re: [libcamera-devel] [PATCH v2 2/2] libcamera: class: Drop 'klass'\n\targument from documentation","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 Tue, Apr 20, 2021 at 11:38:59AM +0200, Jacopo Mondi wrote:\n> The LIBCAMERA_D_PTR() and LIBCAMERA_O_PTR() macros do not require an\n> argument, but the version of the macro consumed by Doxygen does.\n\nOops, indeed.\n\n> Fix this by removing the klass parameter from both macros in their\n> documentation version.\n> \n> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>\n\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\n> ---\n>  include/libcamera/class.h | 4 ++--\n>  src/libcamera/class.cpp   | 6 ++----\n>  2 files changed, 4 insertions(+), 6 deletions(-)\n> \n> diff --git a/include/libcamera/class.h b/include/libcamera/class.h\n> index 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\n> diff --git a/src/libcamera/class.cpp b/src/libcamera/class.cpp\n> index 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","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 7779FBDB16\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Apr 2021 22:53:01 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 3B6A768839;\n\tWed, 21 Apr 2021 00:53:01 +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 DF9A7602C8\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 21 Apr 2021 00:52:59 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 75CAA3EE;\n\tWed, 21 Apr 2021 00:52:59 +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=\"adNALWgY\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1618959179;\n\tbh=idEkVLGsGD7uxCDsCcK6673RzDETOZFPtav3FK29/iE=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=adNALWgYT11pOJfeaPf3IRMPaSgGZYyfBzMOZgO6I6viSbTw6V/TDNBWFE+TAaj6H\n\tdGnaKyKVZgyrIThVLf5hwlA2Op0yaJEY9fbEQTL5sHtRrsYluitkSikRkYctoFNpTI\n\tEqvsdG6kAKh2wqsKgytie5LRJnb0JuodcFxLAbvI=","Date":"Wed, 21 Apr 2021 01:52:55 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Jacopo Mondi <jacopo@jmondi.org>","Message-ID":"<YH9bR/vCVT8o8uLW@pendragon.ideasonboard.com>","References":"<20210420093859.14280-1-jacopo@jmondi.org>\n\t<20210420093859.14280-3-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20210420093859.14280-3-jacopo@jmondi.org>","Subject":"Re: [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>","Cc":"libcamera-devel@lists.libcamera.org","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>"}}]