[{"id":18301,"web_url":"https://patchwork.libcamera.org/comment/18301/","msgid":"<YPu6Ke+oN07HV9Xi@oden.dyn.berto.se>","date":"2021-07-24T06:58:49","subject":"Re: [libcamera-devel] [RFC PATCH 05/17] Documentation: Doxygen:\n\tDon't exclude Private classes","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Laurent,\n\nThanks for your work.\n\nOn 2021-07-23 07:00:24 +0300, Laurent Pinchart wrote:\n> Some of the libcamera Private classes are part of the internal API\n> exposed to pipeline handlers, and should thus be documented as such.\n> Drop the wildcard exclusion, and exclude fully private classes\n> explicitly instead.\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  Documentation/Doxyfile.in | 3 ++-\n>  1 file changed, 2 insertions(+), 1 deletion(-)\n> \n> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> index a79d37706faf..aee5c9fd7e59 100644\n> --- a/Documentation/Doxyfile.in\n> +++ b/Documentation/Doxyfile.in\n> @@ -882,8 +882,9 @@ EXCLUDE_SYMBOLS        = libcamera::BoundMethodArgs \\\n>                           libcamera::BoundMethodPack \\\n>                           libcamera::BoundMethodPackBase \\\n>                           libcamera::BoundMethodStatic \\\n> +\t\t\t libcamera::Camera::Private \\\n> +\t\t\t libcamera::CameraManager::Private \\\n\nThis adds indentation by tabs while the context is spaces. Not sure what \nis correct but if they are updated to match,\n\nReviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n\n>                           libcamera::SignalBase \\\n> -                         libcamera::*::Private \\\n>                           *::details \\\n>                           std::*\n>  \n> -- \n> Regards,\n> \n> Laurent Pinchart\n>","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 008B1C322C\n\tfor <parsemail@patchwork.libcamera.org>;\n\tSat, 24 Jul 2021 06:58:51 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 72AB2687A9;\n\tSat, 24 Jul 2021 08:58:51 +0200 (CEST)","from mail-lj1-x232.google.com (mail-lj1-x232.google.com\n\t[IPv6:2a00:1450:4864:20::232])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id C28E660273\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tSat, 24 Jul 2021 08:58:50 +0200 (CEST)","by mail-lj1-x232.google.com with SMTP id b21so4346235ljo.13\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 23 Jul 2021 23:58:50 -0700 (PDT)","from localhost (h-46-59-88-219.A463.priv.bahnhof.se.\n\t[46.59.88.219]) by smtp.gmail.com with ESMTPSA id\n\tf2sm629216ljq.131.2021.07.23.23.58.49\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tFri, 23 Jul 2021 23:58:49 -0700 (PDT)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (2048-bit key;\n\tunprotected) header.d=ragnatech-se.20150623.gappssmtp.com\n\theader.i=@ragnatech-se.20150623.gappssmtp.com\n\theader.b=\"DH9LXCRS\"; 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=gJjGDskt+/N7KIpI3rh0zqO/F4YmSwWAxrjCh9RTypM=;\n\tb=DH9LXCRSzzmVGOfEAevav82sJ3BSPZisn5wnxJIp4ngPU+klBlc2HnllPdOlakLji0\n\tNlmvekb09YSqvX4nIcLmUn5xAYnNaNtLmlkjl6uh4F16swHquvB77bzLIBEpIz1/2+eT\n\t7UsAFcnywLvtuJYBJcHhXsaUR8LMcrNn0tVoXeO4qHKeLHK7/HBGlcUizSZsFuIzMF9B\n\tC51NCtHxNAU9Hu2N/1nb01KBSNIg1s8gnd4h+6x1pJkKUQok37lxSU+kk+PIpuS9EHeO\n\t9zFtQ7Oin1Bsj/u/SOhV7wpmfDfALgi7P3wmP2SdSYWqJVi2JUu65E2sVSckGF8R0SYs\n\tF6LA==","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=gJjGDskt+/N7KIpI3rh0zqO/F4YmSwWAxrjCh9RTypM=;\n\tb=Q+iooyLt29Nil9ozwbu9xFniglmT3rz5UGdfJMqDNACrr8VhTgt/1mG1QrtJHDPhhY\n\twvjxxHggct8qm1+WGS0P2Z+BabI0L9XgHlnSWm9tKShB+ZcjDCePdDiQZ4qgU+s2kdHG\n\tiliqDjpAVXQBIAbIGb7CnwSjl3EMAWG0jTN/TEENtgkv/pTLkdGVZcA+t5eJh62yucRD\n\tIznHC8Fv+YqdyNxv/nEJO0QmPrziAnmBoy6uW7dOO1Lj02hik8l2zKljCYjTyk/V3gls\n\tQDW+T1W043TOjsnmY0/WoCTEsQN9aCBuvGGFXIwFtRzkWsRgGyBBd3mk3YdEi7J/gJGR\n\tzKTw==","X-Gm-Message-State":"AOAM532tk1tXtmSE2Mxna3aAv+FyJ37PLlo2ZABEzC0e+kE9e5e49NZL\n\tfpx6q3IbADHcVIpCjCn8N1+RpFTPv4oEKA==","X-Google-Smtp-Source":"ABdhPJw+eBP9NZ9LiBvFQVr4j2wrpZsGff2uhzWpY3Jubf9kF68ngo3l1OBMPgwzXwSpNRQpaoNOfw==","X-Received":"by 2002:a2e:a54d:: with SMTP id e13mr5568674ljn.1.1627109930201; \n\tFri, 23 Jul 2021 23:58:50 -0700 (PDT)","Date":"Sat, 24 Jul 2021 08:58:49 +0200","From":"Niklas =?iso-8859-1?q?S=F6derlund?= <niklas.soderlund@ragnatech.se>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Message-ID":"<YPu6Ke+oN07HV9Xi@oden.dyn.berto.se>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>\n\t<20210723040036.32346-6-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20210723040036.32346-6-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [RFC PATCH 05/17] Documentation: Doxygen:\n\tDon't exclude Private classes","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}},{"id":18315,"web_url":"https://patchwork.libcamera.org/comment/18315/","msgid":"<YPxiEYlfEZEHjImW@pendragon.ideasonboard.com>","date":"2021-07-24T18:55:13","subject":"Re: [libcamera-devel] [RFC PATCH 05/17] Documentation: Doxygen:\n\tDon't exclude Private classes","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Niklas,\n\nOn Sat, Jul 24, 2021 at 08:58:49AM +0200, Niklas Söderlund wrote:\n> On 2021-07-23 07:00:24 +0300, Laurent Pinchart wrote:\n> > Some of the libcamera Private classes are part of the internal API\n> > exposed to pipeline handlers, and should thus be documented as such.\n> > Drop the wildcard exclusion, and exclude fully private classes\n> > explicitly instead.\n> > \n> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> > ---\n> >  Documentation/Doxyfile.in | 3 ++-\n> >  1 file changed, 2 insertions(+), 1 deletion(-)\n> > \n> > diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> > index a79d37706faf..aee5c9fd7e59 100644\n> > --- a/Documentation/Doxyfile.in\n> > +++ b/Documentation/Doxyfile.in\n> > @@ -882,8 +882,9 @@ EXCLUDE_SYMBOLS        = libcamera::BoundMethodArgs \\\n> >                           libcamera::BoundMethodPack \\\n> >                           libcamera::BoundMethodPackBase \\\n> >                           libcamera::BoundMethodStatic \\\n> > +\t\t\t libcamera::Camera::Private \\\n> > +\t\t\t libcamera::CameraManager::Private \\\n> \n> This adds indentation by tabs while the context is spaces. Not sure what \n> is correct but if they are updated to match,\n\nOops. Will fix.\n\n> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n> \n> >                           libcamera::SignalBase \\\n> > -                         libcamera::*::Private \\\n> >                           *::details \\\n> >                           std::*\n> >","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 A1831C0109\n\tfor <parsemail@patchwork.libcamera.org>;\n\tSat, 24 Jul 2021 18:55:18 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 59EBF687AF;\n\tSat, 24 Jul 2021 20:55:18 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id D711168536\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tSat, 24 Jul 2021 20:55:16 +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 73C7E3D7;\n\tSat, 24 Jul 2021 20:55:16 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"rUOnrzNZ\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1627152916;\n\tbh=YWp2p4+2t7iqo9Oa0VTsjBO5Z2h9dhx1i74NADlhiMM=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=rUOnrzNZP7TE/hshkXg7iEtFF2MeBBURsoIXXmsyPg8RyoQ5EhlfeBHtS1iJfrioc\n\tjVhwmLgWE4qZQn2YsA8fb0tT6c40MJOV2lypYIZS7c9UQPCHSTJNEj2LFSIyl1Sw2E\n\tfEYPmGKC6AxcY5I1ltDKxtmxEjUQ4IEnYfhzyjjs=","Date":"Sat, 24 Jul 2021 21:55:13 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Niklas =?utf-8?q?S=C3=B6derlund?= <niklas.soderlund@ragnatech.se>","Message-ID":"<YPxiEYlfEZEHjImW@pendragon.ideasonboard.com>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>\n\t<20210723040036.32346-6-laurent.pinchart@ideasonboard.com>\n\t<YPu6Ke+oN07HV9Xi@oden.dyn.berto.se>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<YPu6Ke+oN07HV9Xi@oden.dyn.berto.se>","Subject":"Re: [libcamera-devel] [RFC PATCH 05/17] Documentation: Doxygen:\n\tDon't exclude Private classes","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}},{"id":18426,"web_url":"https://patchwork.libcamera.org/comment/18426/","msgid":"<20210729204027.27bpipyejqomt6ox@uno.localdomain>","date":"2021-07-29T20:40:27","subject":"Re: [libcamera-devel] [RFC PATCH 05/17] Documentation: Doxygen:\n\tDon't exclude Private classes","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent,\n\nOn Fri, Jul 23, 2021 at 07:00:24AM +0300, Laurent Pinchart wrote:\n> Some of the libcamera Private classes are part of the internal API\n> exposed to pipeline handlers, and should thus be documented as such.\n> Drop the wildcard exclusion, and exclude fully private classes\n> explicitly instead.\n>\n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\nWith the space/tab conversion reported by Niklas\n\nReviewed-by: Jacopo Mondi <jacopo@jmondi.org>\n\nThanks\n  j\n> ---\n>  Documentation/Doxyfile.in | 3 ++-\n>  1 file changed, 2 insertions(+), 1 deletion(-)\n>\n> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> index a79d37706faf..aee5c9fd7e59 100644\n> --- a/Documentation/Doxyfile.in\n> +++ b/Documentation/Doxyfile.in\n> @@ -882,8 +882,9 @@ EXCLUDE_SYMBOLS        = libcamera::BoundMethodArgs \\\n>                           libcamera::BoundMethodPack \\\n>                           libcamera::BoundMethodPackBase \\\n>                           libcamera::BoundMethodStatic \\\n> +\t\t\t libcamera::Camera::Private \\\n> +\t\t\t libcamera::CameraManager::Private \\\n>                           libcamera::SignalBase \\\n> -                         libcamera::*::Private \\\n>                           *::details \\\n>                           std::*\n>\n> --\n> Regards,\n>\n> Laurent Pinchart\n>","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 E0E4FC3230\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu, 29 Jul 2021 20:39:43 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 3E099687BF;\n\tThu, 29 Jul 2021 22:39:43 +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 0679E687BA\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 29 Jul 2021 22:39:42 +0200 (CEST)","(Authenticated sender: jacopo@jmondi.org)\n\tby relay8-d.mail.gandi.net (Postfix) with ESMTPSA id 2B6421BF205;\n\tThu, 29 Jul 2021 20:39:40 +0000 (UTC)"],"Date":"Thu, 29 Jul 2021 22:40:27 +0200","From":"Jacopo Mondi <jacopo@jmondi.org>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Message-ID":"<20210729204027.27bpipyejqomt6ox@uno.localdomain>","References":"<20210723040036.32346-1-laurent.pinchart@ideasonboard.com>\n\t<20210723040036.32346-6-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20210723040036.32346-6-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [RFC PATCH 05/17] Documentation: Doxygen:\n\tDon't exclude Private classes","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}}]