{"id":177,"url":"https://patchwork.libcamera.org/api/patches/177/?format=json","web_url":"https://patchwork.libcamera.org/patch/177/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20190108132106.24906-3-kieran.bingham@ideasonboard.com>","date":"2019-01-08T13:21:06","name":"[libcamera-devel,2/2,RFC] Documentation: Enable parameter documentation warnings","commit_ref":null,"pull_url":null,"state":"rejected","archived":false,"hash":"d3ab075bd36d4bfd580b5fd6b9bf30673d035197","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/?format=json","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/177/mbox/","series":[{"id":57,"url":"https://patchwork.libcamera.org/api/series/57/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=57","date":"2019-01-08T13:21:04","name":"Documentation: Quieten Doxygen","version":1,"mbox":"https://patchwork.libcamera.org/series/57/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/177/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/177/checks/","tags":{},"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 C990860B2F\n\tfor ;\n\tTue, 8 Jan 2019 14:21:13 +0100 (CET)","from localhost.localdomain\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 54760E22;\n\tTue, 8 Jan 2019 14:21:13 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1546953673;\n\tbh=vutsl7wOS7ALv5mgLtYHwJ0pCQ8aRDaf5sc7PF16CzQ=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=jhozu4G/2tAhz1hUTOYJy+rZV1eC2rcbN86IxctrPSOqL/3K1WBRqhltr+3TuGFW0\n\tpUu8otwCOXPhv2qbE8YuvxuFaU1x3sCyeVhKQjjSqQFeOWmjlCgUnh9MnTVvBH/mq0\n\tSHAU/Ob7Tz5SPZLKIRjX6UcoFiRpvjUHYejHCdzw=","From":"Kieran Bingham ","To":"LibCamera Devel ","Date":"Tue, 8 Jan 2019 13:21:06 +0000","Message-Id":"<20190108132106.24906-3-kieran.bingham@ideasonboard.com>","X-Mailer":"git-send-email 2.17.1","In-Reply-To":"<20190108132106.24906-1-kieran.bingham@ideasonboard.com>","References":"<20190108132106.24906-1-kieran.bingham@ideasonboard.com>","Subject":"[libcamera-devel] [PATCH 2/2] [RFC] Documentation: Enable parameter\n\tdocumentation warnings","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":"Tue, 08 Jan 2019 13:21:13 -0000"},"content":"Enable WARN_NO_PARAMDOC to guide us towards more complete documentation.\n\nSigned-off-by: Kieran Bingham \n\n---\nThis currently generates the following extra warnings:\n\n src/libcamera/pipeline/vimc.cpp:17: warning: Compound libcamera::PipeHandlerVimc is not documented.\n include/libcamera/camera_manager.h:20: warning: Compound libcamera::CameraManager is not documented.\n src/libcamera/include/device_enumerator.h:37: warning: return type of member libcamera::DeviceEnumerator::create is not documented\n src/libcamera/include/log.h:26: warning: parameters of member libcamera::LogMessage::LogMessage are not (all) documented\n src/libcamera/include/log.h:24: warning: parameters of member libcamera::LogMessage::LogMessage are not (all) documented\n src/libcamera/include/log.h:29: warning: return type of member libcamera::LogMessage::stream is not documented\n src/libcamera/include/media_object.h:94: warning: parameters of member libcamera::MediaEntity::MediaDevice are not (all) documented\n src/libcamera/include/media_object.h:43: warning: parameters of member libcamera::MediaLink::MediaDevice are not (all) documented\n src/libcamera/include/media_object.h:27: warning: parameters of member libcamera::MediaObject::MediaDevice are not (all) documented\n src/libcamera/include/media_object.h:66: warning: parameters of member libcamera::MediaPad::MediaDevice are not (all) documented\n src/libcamera/pipeline/vimc.cpp:22: warning: parameters of member libcamera::PipeHandlerVimc::match are not (all) documented\n src/libcamera/include/pipeline_handler.h:25: warning: parameters of member libcamera::PipelineHandler::match are not (all) documented\n\n Documentation/Doxyfile.in | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)","diff":"diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\nindex 335664dbcbf0..9dfab0852a9d 100644\n--- a/Documentation/Doxyfile.in\n+++ b/Documentation/Doxyfile.in\n@@ -757,7 +757,7 @@ WARN_IF_DOC_ERROR = YES\n # parameter documentation, but not about the absence of documentation.\n # The default value is: NO.\n \n-WARN_NO_PARAMDOC = NO\n+WARN_NO_PARAMDOC = YES\n \n # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when\n # a warning is encountered.\n","prefixes":["libcamera-devel","2/2","RFC"]}