From patchwork Tue Jan 8 13:21:06 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 177 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id C990860B2F for ; Tue, 8 Jan 2019 14:21:13 +0100 (CET) Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 54760E22; Tue, 8 Jan 2019 14:21:13 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1546953673; bh=vutsl7wOS7ALv5mgLtYHwJ0pCQ8aRDaf5sc7PF16CzQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=jhozu4G/2tAhz1hUTOYJy+rZV1eC2rcbN86IxctrPSOqL/3K1WBRqhltr+3TuGFW0 pUu8otwCOXPhv2qbE8YuvxuFaU1x3sCyeVhKQjjSqQFeOWmjlCgUnh9MnTVvBH/mq0 SHAU/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 documentation warnings X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 08 Jan 2019 13:21:13 -0000 Enable WARN_NO_PARAMDOC to guide us towards more complete documentation. Signed-off-by: Kieran Bingham --- This currently generates the following extra warnings: src/libcamera/pipeline/vimc.cpp:17: warning: Compound libcamera::PipeHandlerVimc is not documented. include/libcamera/camera_manager.h:20: warning: Compound libcamera::CameraManager is not documented. src/libcamera/include/device_enumerator.h:37: warning: return type of member libcamera::DeviceEnumerator::create is not documented src/libcamera/include/log.h:26: warning: parameters of member libcamera::LogMessage::LogMessage are not (all) documented src/libcamera/include/log.h:24: warning: parameters of member libcamera::LogMessage::LogMessage are not (all) documented src/libcamera/include/log.h:29: warning: return type of member libcamera::LogMessage::stream is not documented src/libcamera/include/media_object.h:94: warning: parameters of member libcamera::MediaEntity::MediaDevice are not (all) documented src/libcamera/include/media_object.h:43: warning: parameters of member libcamera::MediaLink::MediaDevice are not (all) documented src/libcamera/include/media_object.h:27: warning: parameters of member libcamera::MediaObject::MediaDevice are not (all) documented src/libcamera/include/media_object.h:66: warning: parameters of member libcamera::MediaPad::MediaDevice are not (all) documented src/libcamera/pipeline/vimc.cpp:22: warning: parameters of member libcamera::PipeHandlerVimc::match are not (all) documented src/libcamera/include/pipeline_handler.h:25: warning: parameters of member libcamera::PipelineHandler::match are not (all) documented Documentation/Doxyfile.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in index 335664dbcbf0..9dfab0852a9d 100644 --- a/Documentation/Doxyfile.in +++ b/Documentation/Doxyfile.in @@ -757,7 +757,7 @@ WARN_IF_DOC_ERROR = YES # parameter documentation, but not about the absence of documentation. # The default value is: NO. -WARN_NO_PARAMDOC = NO +WARN_NO_PARAMDOC = YES # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered.